> For the complete documentation index, see [llms.txt](https://docs.fulfillmenttools.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fulfillmenttools.com/documentation/apis/api-reference/models.md).

# Models

## The AbortPickJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbortPickJob":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'AbortPickJob', because you want to cancel a pickjob","enum":["AbortPickJob"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickjobs/:id/actions instead","title":"AbortPickJob","xml":{"name":"AbortPickJob"}}}}}
```

## The AbsoluteSurchargeCostDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The AbstractArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AbstractArticleForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AbstractCarrierCredentials object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractCarrierCredentials","type":"object","description":"AbstractCarrierCredentials"}}}}
```

## The AbstractCostDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The AbstractFacilityActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractFacilityActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractFacilityActionsParameter","description":"AbstractFacilityActionsParameter"}}}}
```

## The AbstractModificationAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The AbstractModifyCarrierCredentials object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractModifyCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractModifyCarrierCredentials","type":"object","description":"AbstractModifyCarrierCredentials"}}}}
```

## The AbstractOrderActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"}}}}
```

## The AbstractOrderLineItemActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractOrderLineItemActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the order to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderLineItemActionsParameter","description":"AbstractOrderLineItemActionsParameter"}}}}
```

## The AbstractProcessActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractProcessActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractProcessActionsParameter","description":"AbstractProcessActionsParameter"}}}}
```

## The AbstractRatingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"}}}}
```

## The AbstractReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The AbstractReasonForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AbstractReasonForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractReasonForModification":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForModification"},"title":"AbstractReasonForModification","description":"AbstractReasonForModification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AbstractReasons object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractReasons":{"properties":{"hasNextPage":{"description":"True if there are more results after the current page","type":"boolean"},"reasons":{"items":{"$ref":"#/components/schemas/AbstractReason"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"required":["reasons","hasNextPage","total"],"type":"object","xml":{"name":"AbstractReasons"},"title":"AbstractReasons","description":"AbstractReasons"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The AbstractRoutingStrategyActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AbstractRoutingStrategyActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractRoutingStrategyActionsParameter","description":"AbstractRoutingStrategyActionsParameter"}}}}
```

## The ActivationTimeFrame object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"}}}}
```

## The ActivationTimeFrameRecurrenceType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"}}}}
```

## The AddAllowedValueToTag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddAllowedValueToTag":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'AddAllowedValueToTag', because you want to add an allowed value to a tag","enum":["AddAllowedValueToTag"],"type":"string"},"allowedValue":{"type":"string"}},"required":["action","allowedValue"],"type":"object"}],"description":"Action to add allowed values to a tag","title":"AddAllowedValueToTag","xml":{"name":"AddAllowedValueToTag"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The AddChannelAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddChannelAction":{"properties":{"channel":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"name":{"enum":["ADD_CHANNEL"],"type":"string"},"version":{"type":"number"}},"required":["name","channel","version"],"title":"AddChannelAction","type":"object","description":"AddChannelAction"},"EmailNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","receiver"],"title":"EmailNotificationChannelForCreation","type":"object","description":"EmailNotificationChannelForCreation"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type"],"title":"ClientNotificationChannelForCreation","type":"object","description":"ClientNotificationChannelForCreation"}}}}
```

## The AddCustomsDocumentToParcelContent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddCustomsDocumentToParcelContent":{"additionalProperties":false,"description":"File and Document for this Label","properties":{"labelFile":{"$ref":"#/components/schemas/AddLabelsToParcelFile"}},"required":["labelFile"],"type":"object","title":"AddCustomsDocumentToParcelContent"},"AddLabelsToParcelFile":{"additionalProperties":false,"description":"file for a given result","properties":{"content":{"description":"File content base64 encoded","type":"string"},"fileName":{"description":"Name of the File that will be created. If not passed the name will be automatically assigned to <labelType>.<type>. Allowed values if passed are: <a-zA-Z0-9_->+<.pdf|.zpl>","maxLength":50,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["content","type"],"type":"object","title":"AddLabelsToParcelFile"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"}}}}
```

## The AddFacilitiesToGroupActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddFacilitiesToGroupActionParameter":{"properties":{"facilitiesToAdd":{"description":"Array of facility references to add to the group. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"maxItems":200,"minItems":1,"type":"array"},"name":{"description":"The name of the action","enum":["ADD_FACILITIES_TO_GROUP"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"number"}},"required":["name","facilitiesToAdd"],"title":"AddFacilitiesToGroupActionParameter","type":"object","description":"AddFacilitiesToGroupActionParameter"}}}}
```

## The AddFacilitiesToGroupVersionlessActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddFacilitiesToGroupVersionlessActionParameter":{"properties":{"facilitiesToAdd":{"description":"Array of facility references to add to the group. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"maxItems":200,"minItems":1,"type":"array"},"name":{"description":"The name of the action","enum":["VERSIONLESS_ADD_FACILITIES_TO_GROUP"],"type":"string"}},"required":["name","facilitiesToAdd"],"title":"AddFacilitiesToGroupVersionlessActionParameter","type":"object","description":"AddFacilitiesToGroupVersionlessActionParameter"}}}}
```

## The AddItemReturnToItemReturnJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddItemReturnToItemReturnJob":{"properties":{"itemReturnForCreation":{"$ref":"#/components/schemas/ItemReturnForCreation"},"itemReturnJobVersion":{"description":"Version of the itemReturnJob the itemReturn gets added to","minimum":0,"type":"integer"}},"required":["itemReturnForCreation","itemReturnJobVersion"],"title":"AddItemReturnToItemReturnJob","type":"object","description":"AddItemReturnToItemReturnJob"},"ItemReturnForCreation":{"properties":{"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemForCreation"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemForCreation"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["status","returnFacilityRef","returnedLineItems"],"title":"ItemReturnForCreation","type":"object","description":"ItemReturnForCreation"},"ItemReturnLineItemForCreation":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReasonForUpsert"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRef":{"description":"id of the item return job line item that is returned","type":"string"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["itemReturnJobLineItemRef","status"],"title":"ItemReturnLineItemForCreation","type":"object","description":"ItemReturnLineItemForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReasonForUpsert":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReasonForUpsert","type":"object","description":"ItemReturnLineItemReasonForUpsert"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"}}}}
```

## The AdditionalHandoverJobLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AdditionalHandoverJobLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["id","article","quantity"],"title":"AdditionalHandoverJobLineItem","description":"AdditionalHandoverJobLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"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. Ensure that no authentication is needed 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"}}}}
```

## The AdditionalHandoverJobLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AdditionalHandoverJobLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["article","quantity"],"title":"AdditionalHandoverJobLineItemForCreation","description":"AdditionalHandoverJobLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"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. Ensure that no authentication is needed 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"}}}}
```

## The AdditionalInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description derived from descriptionLocalized based on the requested locale","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name derived from nameLocalized based on the requested locale","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"Id to identifiy the additional information on an external system. Must be unique per CustomService.","minLength":1,"type":"string"},"valueType":{"description":"Type of the value","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"AdditionalInformation","type":"object","description":"AdditionalInformation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AdditionalInformationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AdditionalInformationForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"tenantAdditionalInformationId":{"description":"Id to identifiy the additional information on an external system. Must be unique per CustomService.","minLength":1,"type":"string"},"valueType":{"description":"Type of the value","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType"],"title":"AdditionalInformationForCreation","type":"object","description":"AdditionalInformationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AdditionalShippingArticleAttribute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AdditionalShippingAttribute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AddLabelsToParcelActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddLabelsToParcelActionEnum":{"enum":["ADD_LABELS_TO_PARCEL"],"type":"string","title":"AddLabelsToParcelActionEnum","description":"AddLabelsToParcelActionEnum"}}}}
```

## The AddLabelsToParcelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddLabelsToParcelActionParameter":{"additionalProperties":false,"properties":{"closeParcel":{"default":false,"description":"Close the parcel after adding this labels. Further adding will not be possible.","type":"boolean"},"customsDocument":{"$ref":"#/components/schemas/AddCustomsDocumentToParcelContent"},"labels":{"items":{"anyOf":[{"$ref":"#/components/schemas/AddLabelsToParcelContent"},{"$ref":"#/components/schemas/AddLabelsToParcelError"}]},"maxItems":2,"minItems":0,"type":"array"},"name":{"$ref":"#/components/schemas/AddLabelsToParcelActionEnum"},"tenantParcelId":{"description":"Optional parameter to set or change the tenant parcel id","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","labels"],"title":"AddLabelsToParcelActionParameter","type":"object","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />AddLabelsToParcelActionParameter"},"AddCustomsDocumentToParcelContent":{"additionalProperties":false,"description":"File and Document for this Label","properties":{"labelFile":{"$ref":"#/components/schemas/AddLabelsToParcelFile"}},"required":["labelFile"],"type":"object","title":"AddCustomsDocumentToParcelContent"},"AddLabelsToParcelFile":{"additionalProperties":false,"description":"file for a given result","properties":{"content":{"description":"File content base64 encoded","type":"string"},"fileName":{"description":"Name of the File that will be created. If not passed the name will be automatically assigned to <labelType>.<type>. Allowed values if passed are: <a-zA-Z0-9_->+<.pdf|.zpl>","maxLength":50,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["content","type"],"type":"object","title":"AddLabelsToParcelFile"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"},"AddLabelsToParcelContent":{"additionalProperties":false,"description":"File and Document for this Label","properties":{"labelFile":{"$ref":"#/components/schemas/AddLabelsToParcelFile"},"labelType":{"$ref":"#/components/schemas/ParcelLabelType"},"trackingNumber":{"description":"The reference number by the carrier","type":"string"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["labelType","labelFile","trackingNumber","trackingUrl"],"type":"object","title":"AddLabelsToParcelContent"},"ParcelLabelType":{"description":"Which kind of label you want to add to the parcel","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelLabelType"},"AddLabelsToParcelError":{"additionalProperties":false,"description":"Error values for a not successfull label request","properties":{"errorCode":{"description":"optional error code from the carrier","type":"string"},"errorDescription":{"description":"raw text error message","type":"string"},"labelType":{"$ref":"#/components/schemas/ParcelLabelType"}},"required":["labelType","errorDescription"],"type":"object","title":"AddLabelsToParcelError"},"AddLabelsToParcelActionEnum":{"enum":["ADD_LABELS_TO_PARCEL"],"type":"string","title":"AddLabelsToParcelActionEnum","description":"AddLabelsToParcelActionEnum"}}}}
```

## The AddLabelsToParcelContent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddLabelsToParcelContent":{"additionalProperties":false,"description":"File and Document for this Label","properties":{"labelFile":{"$ref":"#/components/schemas/AddLabelsToParcelFile"},"labelType":{"$ref":"#/components/schemas/ParcelLabelType"},"trackingNumber":{"description":"The reference number by the carrier","type":"string"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["labelType","labelFile","trackingNumber","trackingUrl"],"type":"object","title":"AddLabelsToParcelContent"},"AddLabelsToParcelFile":{"additionalProperties":false,"description":"file for a given result","properties":{"content":{"description":"File content base64 encoded","type":"string"},"fileName":{"description":"Name of the File that will be created. If not passed the name will be automatically assigned to <labelType>.<type>. Allowed values if passed are: <a-zA-Z0-9_->+<.pdf|.zpl>","maxLength":50,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["content","type"],"type":"object","title":"AddLabelsToParcelFile"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"},"ParcelLabelType":{"description":"Which kind of label you want to add to the parcel","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelLabelType"}}}}
```

## The AddLabelsToParcelError object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddLabelsToParcelError":{"additionalProperties":false,"description":"Error values for a not successfull label request","properties":{"errorCode":{"description":"optional error code from the carrier","type":"string"},"errorDescription":{"description":"raw text error message","type":"string"},"labelType":{"$ref":"#/components/schemas/ParcelLabelType"}},"required":["labelType","errorDescription"],"type":"object","title":"AddLabelsToParcelError"},"ParcelLabelType":{"description":"Which kind of label you want to add to the parcel","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelLabelType"}}}}
```

## The AddLabelsToParcelFile object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddLabelsToParcelFile":{"additionalProperties":false,"description":"file for a given result","properties":{"content":{"description":"File content base64 encoded","type":"string"},"fileName":{"description":"Name of the File that will be created. If not passed the name will be automatically assigned to <labelType>.<type>. Allowed values if passed are: <a-zA-Z0-9_->+<.pdf|.zpl>","maxLength":50,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["content","type"],"type":"object","title":"AddLabelsToParcelFile"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"}}}}
```

## The AddLineItemToPackingTargetContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddLineItemToPackingTargetContainer":{"additionalProperties":false,"description":"Action to a line item to a packing target container.","properties":{"action":{"description":"'Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead'","enum":["AddLineItemToPackingTargetContainer"],"type":"string"},"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"}},"required":["action","lineItem"],"title":"AddLineItemToPackingTargetContainer","type":"object","xml":{"name":"AddLineItemToPackingTargetContainer"}},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["article","quantity"],"type":"object","title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The AddRefuseReasonParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddRefuseReasonParameter":{"additionalProperties":false,"properties":{"availableRefuseReasonForCreation":{"$ref":"#/components/schemas/AvailableRefuseReasonForCreation"},"handoverConfigurationVersion":{"type":"number"}},"required":["handoverConfigurationVersion","availableRefuseReasonForCreation"],"type":"object","title":"AddRefuseReasonParameter","description":"AddRefuseReasonParameter"},"AvailableRefuseReasonForCreation":{"additionalProperties":false,"properties":{"refusedReasonLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized reason"},"active":{"type":"boolean"}},"required":["active","refusedReasonLocalized"],"type":"object","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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AddRemoteConfigurationScopeParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddRemoteConfigurationScopeParameter":{"properties":{"remoteConfigVersion":{"description":"The version of the remote config for optimistic locking","minimum":0,"type":"number"},"scope":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationScopeForCreation"}],"description":"The scope to add"}},"required":["scope","remoteConfigVersion"],"title":"AddRemoteConfigurationScopeParameter","type":"object","description":"AddRemoteConfigurationScopeParameter"},"RemoteConfigurationScopeForCreation":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"title":"RemoteConfigurationScopeForCreation","type":"object","description":"RemoteConfigurationScopeForCreation"}}}}
```

## The Address object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"maxItems":500,"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"}}}}
```

## The AddressType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The AddServiceDataAvailableLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddServiceDataAvailableLineItemsActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'ADD_SERVICE_DATA_AVAILABLE_LINE_ITEMS'","enum":["ADD_SERVICE_DATA_AVAILABLE_LINE_ITEMS"],"type":"string"},"serviceDataAvailableLineItems":{"description":"Service data available line items to be added","items":{"$ref":"#/components/schemas/ServiceDataAvailableLineItemForCreation"},"maxItems":50,"minItems":1,"type":"array"},"serviceDataVersion":{"description":"Version of the service data","minimum":0,"type":"integer"}},"required":["name","serviceDataAvailableLineItems","serviceDataVersion"],"title":"AddServiceDataAvailableLineItemsActionParameter","type":"object","description":"AddServiceDataAvailableLineItemsActionParameter"},"ServiceDataAvailableLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information for this available line item"},"availableQuantity":{"description":"Quantity of the item that is available","minimum":0,"type":"integer"},"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"},"executedServiceJobData":{"description":"History of service jobs that have processed this available line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":0,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity","availableQuantity","executedServiceJobData"],"title":"ServiceDataAvailableLineItemForCreation","type":"object","description":"ServiceDataAvailableLineItemForCreation"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The AddTagsToProcess object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddTagsToProcess":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'AddTagsToProcess', because you want to modify a process","enum":["AddTagsToProcess"],"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["action"],"type":"object"}],"description":"Action to add tags to a Process","title":"AddTagsToProcessAction","xml":{"name":"AddTagsToProcess"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The AddTagsToProcessActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddTagsToProcessActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to add tags to a process.","properties":{"name":{"enum":["ADD_TAGS_TO_PROCESS"],"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":10,"minItems":1,"type":"array"}},"required":["name","version","tags"],"title":"AddTagsToProcessActionParameter"},"AbstractProcessActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractProcessActionsParameter","description":"AbstractProcessActionsParameter"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The AddTargetTimeToOperativeProcessEntitiesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AddTargetTimeToOperativeProcessEntitiesActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'ADD_TARGET_TIME_TO_OPERATIVE_PROCESS_ENTITIES'","enum":["ADD_TARGET_TIME_TO_OPERATIVE_PROCESS_ENTITIES"],"type":"string"},"operativeProcessVersion":{"description":"Version of the service job","minimum":0,"type":"integer"},"targetTime":{"description":"TargetTime you want to set for PickJobs, PackJobs, ServiceJobs and HandoverJobs that do not have a targetTime ServiceJob. Only effects entities of that operativeProcess.","format":"date-time","type":"string"}},"required":["name","operativeProcessVersion","targetTime"],"title":"AddTargetTimeToOperativeProcessEntitiesActionParameter","type":"object","description":"AddTargetTimeToOperativeProcessEntitiesActionParameter"}}}}
```

## The AlternativeReturnAddressConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AlternativeReturnAddressConfiguration":{"additionalProperties":false,"properties":{"alternativeReturnAddressPerTag":{"items":{"$ref":"#/components/schemas/AlternativeReturnAddressPerTag"},"minItems":0,"type":"array"}},"required":["alternativeReturnAddressPerTag"],"title":"AlternativeReturnAddressConfiguration","description":"AlternativeReturnAddressConfiguration"},"AlternativeReturnAddressPerTag":{"additionalProperties":false,"properties":{"alternativeReturnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"tagRef":{"description":"needs to be an existing tag id","type":"string"}},"required":["tagRef","matchingValues","alternativeReturnAddress"],"title":"AlternativeReturnAddressPerTag","description":"AlternativeReturnAddressPerTag"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The AlternativeReturnAddressPerTag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AlternativeReturnAddressPerTag":{"additionalProperties":false,"properties":{"alternativeReturnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"tagRef":{"description":"needs to be an existing tag id","type":"string"}},"required":["tagRef","matchingValues","alternativeReturnAddress"],"title":"AlternativeReturnAddressPerTag","description":"AlternativeReturnAddressPerTag"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The AnnounceItemReturnActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AnnounceItemReturnActionParameter":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"enum":["AnnounceItemReturn"],"type":"string"}},"required":["name","itemReturnJobVersion"],"title":"AnnounceItemReturnActionParameter","type":"object","description":"AnnounceItemReturnActionParameter"}}}}
```

## The ApiError object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The ArticleAttributeItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The ArticleAttributeItemContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The ArticleAttributeItemType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ArticleAttributeItemType":{"description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string","xml":{"name":"ArticleAttributeItemType"},"title":"ArticleAttributeItemType"}}}}
```

## The ArticleAvailabilityStockValues object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ArticleAvailabilityStockValues":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"stockOnHand":{"type":"number"},"total":{"type":"number"}},"required":["total","stockOnHand","availableOnStock","availableForPicking"],"title":"ArticleAvailabilityStockValues","type":"object","description":"ArticleAvailabilityStockValues"}}}}
```

## The ArticleHistoryLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ArticleItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"}}}}
```

## The ArticlePrice object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The ArticleStockForecast object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ArticleStockForecast":{"properties":{"created":{"format":"date-time","type":"string"},"cumulated":{"type":"number"},"cumulatedLowerBounds":{"items":{"type":"number"},"type":"array"},"cumulatedUpperBounds":{"items":{"type":"number"},"type":"array"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"loadTime":{"format":"date-time","type":"string"},"lowerBounds":{"items":{"type":"number"},"type":"array"},"period":{"enum":["DAILY"],"type":"string"},"point":{"type":"number"},"sourceDate":{"format":"date-time","type":"string"},"targetDate":{"format":"date-time","type":"string"},"tenantArticleId":{"type":"string"},"upperBounds":{"items":{"type":"number"},"type":"array"}},"required":["id","tenantArticleId","created","lastModified","sourceDate","targetDate","loadTime","cumulated","cumulatedLowerBounds","cumulatedUpperBounds","lowerBounds","upperBounds","period","point"],"title":"ArticleStockForecast","type":"object","description":"ArticleStockForecast"}}}}
```

## The ArtifactMetadataItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ArtifactMetadataItem":{"properties":{"buildDate":{"description":"Date of the build of the artifact","format":"date-time","type":"string"},"download":{"properties":{"expiration":{"description":"Expiration date of the download link","format":"date-time","type":"string"},"url":{"description":"URL for the download of the artifact","type":"string"}},"type":"object"},"versionCode":{"description":"Version Code of the artifact","type":"number"},"versionName":{"description":"Version Name of the artifact","type":"string"}},"required":["download","versionCode","versionName","buildDate"],"type":"object","title":"ArtifactMetadataItem","description":"ArtifactMetadataItem"}}}}
```

## The ArtifactMetadataItems object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ArtifactMetadataItems":{"properties":{"artifacts":{"items":{"$ref":"#/components/schemas/ArtifactMetadataItem"},"type":"array"},"platform":{"description":"Platform name for which the artifact list is generated","type":"string"}},"required":["artifacts","platform"],"type":"object","title":"ArtifactMetadataItems","description":"ArtifactMetadataItems"},"ArtifactMetadataItem":{"properties":{"buildDate":{"description":"Date of the build of the artifact","format":"date-time","type":"string"},"download":{"properties":{"expiration":{"description":"Expiration date of the download link","format":"date-time","type":"string"},"url":{"description":"URL for the download of the artifact","type":"string"}},"type":"object"},"versionCode":{"description":"Version Code of the artifact","type":"number"},"versionName":{"description":"Version Name of the artifact","type":"string"}},"required":["download","versionCode","versionName","buildDate"],"type":"object","title":"ArtifactMetadataItem","description":"ArtifactMetadataItem"}}}}
```

## The AssignedGroup object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AssignedGroup":{"properties":{"facilityRefs":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"}},"required":["facilityRefs","group"],"title":"AssignedGroup","type":"object","description":"AssignedGroup"}}}}
```

## The AssignedRequiredLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"}}}}
```

## The AssignedRoles object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The AssignedUser object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The AssignedUserForCreationById object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The AssignedUserForCreationByName object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The AssignFacilityToProcess object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AssignFacilityToProcess":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value to manually assign a facility to a process","enum":["AssignFacilityToProcess"],"type":"string"},"facilityRef":{"type":"string"},"rerouteDescriptionId":{"type":"string"}},"required":["action","facilityRef"],"type":"object"}],"description":"Action to assign a process to a facility.","title":"AssignFacilityToProcessAction","xml":{"name":"AssignFacilityToProcess"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The AssignFacilityToProcessActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AssignFacilityToProcessActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to assign a facility to a process.","properties":{"facilityRef":{"type":"string"},"name":{"enum":["ASSIGN_FACILITY_TO_PROCESS"],"type":"string"},"rerouteDescriptionId":{"type":"string"}},"required":["name","version","facilityRef"],"title":"AssignFacilityToProcessActionParameter"},"AbstractProcessActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractProcessActionsParameter","description":"AbstractProcessActionsParameter"}}}}
```

## The AssignmentItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AssignmentItem":{"properties":{"articleTitle":{"type":"string"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"AssignmentItem","description":"AssignmentItem"}}}}
```

## The Audit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Audit":{"properties":{"actor":{"$ref":"#/components/schemas/AuditActor"},"anonymizationDate":{"format":"date-time","type":"string"},"client":{"$ref":"#/components/schemas/AuditClient"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"deletionDate":{"format":"date-time","type":"string"},"entityCreated":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"entityType":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"entityVersion":{"type":"number"},"eventId":{"type":"string"},"globalActor":{"$ref":"#/components/schemas/AuditActor"},"id":{"type":"string"},"isAnonymized":{"type":"boolean"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"operation":{"$ref":"#/components/schemas/AuditOperation"},"trace":{"type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["id","eventId","entityRef","entityType","entityVersion","isAnonymized","entityCreated","deletionDate","anonymizationDate","trace","actor","globalActor","client","operation","version"],"title":"Audit","type":"object","description":"Audit"},"AuditActor":{"properties":{"details":{"$ref":"#/components/schemas/AuditActorDetails"},"id":{"type":"string"}},"required":["id","details"],"title":"AuditActor","type":"object","description":"AuditActor"},"AuditActorDetails":{"properties":{"topic":{"type":"string"},"username":{"type":"string"}},"required":["topic","username"],"title":"AuditActorDetails","type":"object","description":"AuditActorDetails"},"AuditClient":{"properties":{"api":{"type":"string"},"rawInfo":{"type":"string"}},"required":["api","rawInfo"],"title":"AuditClient","type":"object","description":"AuditClient"},"AuditOperation":{"properties":{"name":{"type":"string"},"start":{"format":"date-time","type":"string"}},"required":["name","start"],"title":"AuditOperation","type":"object","description":"AuditOperation"}}}}
```

## The AuditActor object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditActor":{"properties":{"details":{"$ref":"#/components/schemas/AuditActorDetails"},"id":{"type":"string"}},"required":["id","details"],"title":"AuditActor","type":"object","description":"AuditActor"},"AuditActorDetails":{"properties":{"topic":{"type":"string"},"username":{"type":"string"}},"required":["topic","username"],"title":"AuditActorDetails","type":"object","description":"AuditActorDetails"}}}}
```

## The AuditActorDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditActorDetails":{"properties":{"topic":{"type":"string"},"username":{"type":"string"}},"required":["topic","username"],"title":"AuditActorDetails","type":"object","description":"AuditActorDetails"}}}}
```

## The AuditClient object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditClient":{"properties":{"api":{"type":"string"},"rawInfo":{"type":"string"}},"required":["api","rawInfo"],"title":"AuditClient","type":"object","description":"AuditClient"}}}}
```

## The AuditedEntityTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditedEntityTypeEnumFilter":{"properties":{"eq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"in":{"description":"Search by entityType","items":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"}},"title":"AuditedEntityTypeEnumFilter","type":"object","description":"AuditedEntityTypeEnumFilter"}}}}
```

## The AuditOperation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditOperation":{"properties":{"name":{"type":"string"},"start":{"format":"date-time","type":"string"}},"required":["name","start"],"title":"AuditOperation","type":"object","description":"AuditOperation"}}}}
```

## The AuditPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditPaginatedResult":{"properties":{"audits":{"items":{"$ref":"#/components/schemas/Audit"},"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","audits"],"title":"AuditPaginatedResult","type":"object","description":"AuditPaginatedResult"},"Audit":{"properties":{"actor":{"$ref":"#/components/schemas/AuditActor"},"anonymizationDate":{"format":"date-time","type":"string"},"client":{"$ref":"#/components/schemas/AuditClient"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"deletionDate":{"format":"date-time","type":"string"},"entityCreated":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"entityType":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"entityVersion":{"type":"number"},"eventId":{"type":"string"},"globalActor":{"$ref":"#/components/schemas/AuditActor"},"id":{"type":"string"},"isAnonymized":{"type":"boolean"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"operation":{"$ref":"#/components/schemas/AuditOperation"},"trace":{"type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["id","eventId","entityRef","entityType","entityVersion","isAnonymized","entityCreated","deletionDate","anonymizationDate","trace","actor","globalActor","client","operation","version"],"title":"Audit","type":"object","description":"Audit"},"AuditActor":{"properties":{"details":{"$ref":"#/components/schemas/AuditActorDetails"},"id":{"type":"string"}},"required":["id","details"],"title":"AuditActor","type":"object","description":"AuditActor"},"AuditActorDetails":{"properties":{"topic":{"type":"string"},"username":{"type":"string"}},"required":["topic","username"],"title":"AuditActorDetails","type":"object","description":"AuditActorDetails"},"AuditClient":{"properties":{"api":{"type":"string"},"rawInfo":{"type":"string"}},"required":["api","rawInfo"],"title":"AuditClient","type":"object","description":"AuditClient"},"AuditOperation":{"properties":{"name":{"type":"string"},"start":{"format":"date-time","type":"string"}},"required":["name","start"],"title":"AuditOperation","type":"object","description":"AuditOperation"},"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"}}}}
```

## The AuditSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditSearchPayload":{"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/AuditSearchQuery"},"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/AuditSort"},"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":"AuditSearchPayload","type":"object","description":"AuditSearchPayload"},"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"},"AuditSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/AuditSearchQuery"},"maxItems":500,"type":"array"},"entityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by entityRef"},"entityType":{"allOf":[{"$ref":"#/components/schemas/AuditedEntityTypeEnumFilter"}],"description":"Search by entityType"},"or":{"items":{"$ref":"#/components/schemas/AuditSearchQuery"},"maxItems":500,"type":"array"},"trace":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by trace"}},"title":"AuditSearchQuery","type":"object","description":"AuditSearchQuery"},"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"},"AuditedEntityTypeEnumFilter":{"properties":{"eq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"in":{"description":"Search by entityType","items":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"}},"title":"AuditedEntityTypeEnumFilter","type":"object","description":"AuditedEntityTypeEnumFilter"},"AuditSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"}},"title":"AuditSort","type":"object","description":"AuditSort"}}}}
```

## The AuditSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/AuditSearchQuery"},"maxItems":500,"type":"array"},"entityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by entityRef"},"entityType":{"allOf":[{"$ref":"#/components/schemas/AuditedEntityTypeEnumFilter"}],"description":"Search by entityType"},"or":{"items":{"$ref":"#/components/schemas/AuditSearchQuery"},"maxItems":500,"type":"array"},"trace":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by trace"}},"title":"AuditSearchQuery","type":"object","description":"AuditSearchQuery"},"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"},"AuditedEntityTypeEnumFilter":{"properties":{"eq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"in":{"description":"Search by entityType","items":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"}},"title":"AuditedEntityTypeEnumFilter","type":"object","description":"AuditedEntityTypeEnumFilter"}}}}
```

## The AuditSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"}},"title":"AuditSort","type":"object","description":"AuditSort"}}}}
```

## The AuditsResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditsResult":{"properties":{"audits":{"description":"The audits that match the filter criteria","items":{"$ref":"#/components/schemas/Audit"},"type":"array"},"total":{"description":"The total number of audits that match the filter criteria","minimum":0,"type":"number"}},"required":["audits","total"],"title":"AuditsResult","type":"object","description":"AuditsResult"},"Audit":{"properties":{"actor":{"$ref":"#/components/schemas/AuditActor"},"anonymizationDate":{"format":"date-time","type":"string"},"client":{"$ref":"#/components/schemas/AuditClient"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"deletionDate":{"format":"date-time","type":"string"},"entityCreated":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"entityType":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB"],"type":"string"},"entityVersion":{"type":"number"},"eventId":{"type":"string"},"globalActor":{"$ref":"#/components/schemas/AuditActor"},"id":{"type":"string"},"isAnonymized":{"type":"boolean"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"operation":{"$ref":"#/components/schemas/AuditOperation"},"trace":{"type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["id","eventId","entityRef","entityType","entityVersion","isAnonymized","entityCreated","deletionDate","anonymizationDate","trace","actor","globalActor","client","operation","version"],"title":"Audit","type":"object","description":"Audit"},"AuditActor":{"properties":{"details":{"$ref":"#/components/schemas/AuditActorDetails"},"id":{"type":"string"}},"required":["id","details"],"title":"AuditActor","type":"object","description":"AuditActor"},"AuditActorDetails":{"properties":{"topic":{"type":"string"},"username":{"type":"string"}},"required":["topic","username"],"title":"AuditActorDetails","type":"object","description":"AuditActorDetails"},"AuditClient":{"properties":{"api":{"type":"string"},"rawInfo":{"type":"string"}},"required":["api","rawInfo"],"title":"AuditClient","type":"object","description":"AuditClient"},"AuditOperation":{"properties":{"name":{"type":"string"},"start":{"format":"date-time","type":"string"}},"required":["name","start"],"title":"AuditOperation","type":"object","description":"AuditOperation"}}}}
```

## The AuthenticationProvider object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"}}}}
```

## The AuthenticationProviderTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"}}}}
```

## The AvailabilityAllocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocation":{"properties":{"channelRef":{"type":"string"},"created":{"format":"date-time","type":"string"},"facilityRef":{"type":"string"},"groupRef":{"type":"string"},"id":{"type":"string"},"initialStockQuantity":{"type":"number"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["facilityRef","initialStockQuantity","groupRef","channelRef","id","version","created","lastModified"],"title":"AvailabilityAllocation","type":"object","description":"AvailabilityAllocation"}}}}
```

## The AvailabilityAllocationForCreationUnderGroup object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocationForCreationUnderGroup":{"properties":{"facilityRef":{"type":"string"},"initialStockQuantity":{"type":"number"}},"required":["facilityRef","initialStockQuantity"],"title":"AvailabilityAllocationForCreationUnderGroup","type":"object","description":"AvailabilityAllocationForCreationUnderGroup"}}}}
```

## The AvailabilityAllocationForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocationForReplacement":{"properties":{"groupId":{"type":"string"},"initialStockQuantity":{"type":"number"},"version":{"type":"number"}},"required":["version","initialStockQuantity"],"title":"AvailabilityAllocationForReplacement","type":"object","description":"AvailabilityAllocationForReplacement"}}}}
```

## The AvailabilityAllocationGroup object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocationGroup":{"properties":{"active":{"type":"boolean"},"activePeriod":{"$ref":"#/components/schemas/AvailabilityAllocationPeriod"},"channelRef":{"type":"string"},"created":{"format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantArticleIds":{"items":{"type":"string"},"maxItems":1,"type":"array"},"version":{"type":"number"}},"required":["tenantArticleIds","active","channelRef","id","version","created","lastModified"],"title":"AvailabilityAllocationGroup","type":"object","description":"AvailabilityAllocationGroup"},"AvailabilityAllocationPeriod":{"properties":{"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"title":"AvailabilityAllocationPeriod","type":"object","description":"AvailabilityAllocationPeriod"}}}}
```

## The AvailabilityAllocationGroupForCreationUnderChannel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocationGroupForCreationUnderChannel":{"properties":{"active":{"type":"boolean"},"activePeriod":{"$ref":"#/components/schemas/AvailabilityAllocationPeriod"},"tenantArticleIds":{"items":{"type":"string"},"maxItems":1,"type":"array"}},"required":["tenantArticleIds","active"],"title":"AvailabilityAllocationGroupForCreationUnderChannel","type":"object","description":"AvailabilityAllocationGroupForCreationUnderChannel"},"AvailabilityAllocationPeriod":{"properties":{"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"title":"AvailabilityAllocationPeriod","type":"object","description":"AvailabilityAllocationPeriod"}}}}
```

## The AvailabilityAllocationGroupForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocationGroupForReplacement":{"properties":{"active":{"type":"boolean"},"activePeriod":{"$ref":"#/components/schemas/AvailabilityAllocationPeriod"},"version":{"type":"number"}},"required":["version","active"],"title":"AvailabilityAllocationGroupForReplacement","type":"object","description":"AvailabilityAllocationGroupForReplacement"},"AvailabilityAllocationPeriod":{"properties":{"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"title":"AvailabilityAllocationPeriod","type":"object","description":"AvailabilityAllocationPeriod"}}}}
```

## The AvailabilityAllocationGroupPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocationGroupPaginatedResult":{"properties":{"groups":{"items":{"$ref":"#/components/schemas/AvailabilityAllocationGroup"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","groups"],"title":"AvailabilityAllocationGroupPaginatedResult","type":"object","description":"AvailabilityAllocationGroupPaginatedResult"},"AvailabilityAllocationGroup":{"properties":{"active":{"type":"boolean"},"activePeriod":{"$ref":"#/components/schemas/AvailabilityAllocationPeriod"},"channelRef":{"type":"string"},"created":{"format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantArticleIds":{"items":{"type":"string"},"maxItems":1,"type":"array"},"version":{"type":"number"}},"required":["tenantArticleIds","active","channelRef","id","version","created","lastModified"],"title":"AvailabilityAllocationGroup","type":"object","description":"AvailabilityAllocationGroup"},"AvailabilityAllocationPeriod":{"properties":{"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"title":"AvailabilityAllocationPeriod","type":"object","description":"AvailabilityAllocationPeriod"}}}}
```

## The AvailabilityAllocationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocationPaginatedResult":{"properties":{"allocations":{"items":{"$ref":"#/components/schemas/AvailabilityChannel"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","allocations"],"title":"AvailabilityAllocationPaginatedResult","type":"object","description":"AvailabilityAllocationPaginatedResult"},"AvailabilityChannel":{"properties":{"created":{"format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"name":{"type":"string"},"strategy":{"enum":["REGULAR","IRON_RESERVE","RESTRICT"],"type":"string"},"version":{"type":"number"}},"required":["name","strategy","version","id","created","lastModified"],"title":"AvailabilityChannel","type":"object","description":"AvailabilityChannel"}}}}
```

## The AvailabilityAllocationPeriod object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityAllocationPeriod":{"properties":{"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"title":"AvailabilityAllocationPeriod","type":"object","description":"AvailabilityAllocationPeriod"}}}}
```

## The AvailabilityChannel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityChannel":{"properties":{"created":{"format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"name":{"type":"string"},"strategy":{"enum":["REGULAR","IRON_RESERVE","RESTRICT"],"type":"string"},"version":{"type":"number"}},"required":["name","strategy","version","id","created","lastModified"],"title":"AvailabilityChannel","type":"object","description":"AvailabilityChannel"}}}}
```

## The AvailabilityChannelForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityChannelForCreation":{"properties":{"name":{"type":"string"},"strategy":{"enum":["REGULAR","IRON_RESERVE","RESTRICT"],"type":"string"}},"required":["name","strategy"],"title":"AvailabilityChannelForCreation","type":"object","description":"AvailabilityChannelForCreation"}}}}
```

## The AvailabilityChannelForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityChannelForReplacement":{"properties":{"name":{"type":"string"},"strategy":{"enum":["REGULAR","IRON_RESERVE","RESTRICT"],"type":"string"},"version":{"type":"number"}},"required":["name","strategy","version"],"title":"AvailabilityChannelForReplacement","type":"object","description":"AvailabilityChannelForReplacement"}}}}
```

## The AvailabilityChannelPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityChannelPaginatedResult":{"properties":{"channels":{"items":{"$ref":"#/components/schemas/AvailabilityChannel"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","channels"],"title":"AvailabilityChannelPaginatedResult","type":"object","description":"AvailabilityChannelPaginatedResult"},"AvailabilityChannel":{"properties":{"created":{"format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"name":{"type":"string"},"strategy":{"enum":["REGULAR","IRON_RESERVE","RESTRICT"],"type":"string"},"version":{"type":"number"}},"required":["name","strategy","version","id","created","lastModified"],"title":"AvailabilityChannel","type":"object","description":"AvailabilityChannel"}}}}
```

## The AvailabilityDuringRerouteStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityDuringRerouteStock":{"properties":{"pickedQuantity":{"type":"number"},"rerouteReason":{"$ref":"#/components/schemas/RerouteReason"}},"title":"AvailabilityDuringRerouteStock","description":"AvailabilityDuringRerouteStock"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"}}}}
```

## The AvailabilityDuringRouting object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityDuringRouting":{"properties":{"articleTitle":{"type":"string"},"available":{"type":"number"},"availablePostRerouteAdjustment":{"type":"number"},"bundleInformation":{"items":{"$ref":"#/components/schemas/BundleInformation"},"type":"array"},"isBackOrderable":{"default":false,"type":"boolean"},"preOrderDate":{"format":"date-time","type":"string"},"requestedQuantity":{"type":"number"},"rerouteInformation":{"$ref":"#/components/schemas/AvailabilityDuringRerouteStock"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","requestedQuantity","available","isBackOrderable"],"title":"AvailabilityDuringRouting","description":"AvailabilityDuringRouting"},"BundleInformation":{"properties":{"customServiceNodeId":{"type":"string"},"requestedQuantity":{"type":"number"}},"required":["customServiceNodeId","requestedQuantity"],"title":"BundleInformation","description":"BundleInformation"},"AvailabilityDuringRerouteStock":{"properties":{"pickedQuantity":{"type":"number"},"rerouteReason":{"$ref":"#/components/schemas/RerouteReason"}},"title":"AvailabilityDuringRerouteStock","description":"AvailabilityDuringRerouteStock"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"}}}}
```

## The AvailabilityTimeframe object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"}}}}
```

## The AvailabilityTimeframe2 object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailabilityTimeframe2":{"properties":{"start":{"type":"string"}},"required":["start"],"title":"AvailabilityTimeframe2","type":"object","description":"AvailabilityTimeframe2"}}}}
```

## The AvailableDecisionReasons object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableDecisionReasons":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"context":{"description":"Context in which this reason is available","items":{"$ref":"#/components/schemas/DecisionReasonContext"},"maxItems":10,"minItems":1,"type":"array"},"reason":{"description":"Translated value from  reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"AvailableDecisionReasons","type":"object","description":"AvailableDecisionReasons"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"DecisionReasonContext":{"properties":{"type":{"enum":["ITEM_RETURN_LINE_ITEM_STATUS"],"type":"string"},"values":{"items":{"enum":["ACCEPTED","REJECTED","WAITING_FOR_INPUT"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"title":"DecisionReasonContext","type":"object","description":"DecisionReasonContext"}}}}
```

## The AvailableForPickingDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableForPickingDetails":{"properties":{"total":{"type":"number"}},"required":["total"],"title":"AvailableForPickingDetails","type":"object","description":"AvailableForPickingDetails"}}}}
```

## The AvailableItemCondition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableItemCondition":{"properties":{"conditionLocalized":{"$ref":"#/components/schemas/LocaleString"}},"required":["conditionLocalized"],"title":"AvailableItemCondition","type":"object","description":"AvailableItemCondition"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AvailableOperativeProcessAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableOperativeProcessAction":{"properties":{"available":{"description":"Indicates whether the action is available for this operative process","type":"boolean"},"denyReasons":{"description":"List of reasons why the action is not available","items":{"$ref":"#/components/schemas/AvailableOperativeProcessActionDenyReason"},"type":"array"},"name":{"description":"Name of the operative process action","enum":["REJECT_OPERATIVE_PROCESS","MANIPULATE_LINE_ITEM_QUANTITY","CHANGE_POSTAL_ADDRESS","ADD_TARGET_TIME"],"type":"string"}},"required":["name","available","denyReasons"],"title":"AvailableOperativeProcessAction","type":"object","description":"AvailableOperativeProcessAction"},"AvailableOperativeProcessActionDenyReason":{"properties":{"errorCode":{"description":"Error code indicating the reason why the action is not available","enum":["PICKING_STARTED","TRANSFER_HAPPENED","HANDOVER_DONE","TARGET_TIME_ALREADY_SET"],"type":"string"},"message":{"description":"Human-readable message describing the deny reason","type":"string"}},"required":["errorCode","message"],"title":"AvailableOperativeProcessActionDenyReason","type":"object","description":"AvailableOperativeProcessActionDenyReason"}}}}
```

## The AvailableOperativeProcessActionDenyReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableOperativeProcessActionDenyReason":{"properties":{"errorCode":{"description":"Error code indicating the reason why the action is not available","enum":["PICKING_STARTED","TRANSFER_HAPPENED","HANDOVER_DONE","TARGET_TIME_ALREADY_SET"],"type":"string"},"message":{"description":"Human-readable message describing the deny reason","type":"string"}},"required":["errorCode","message"],"title":"AvailableOperativeProcessActionDenyReason","type":"object","description":"AvailableOperativeProcessActionDenyReason"}}}}
```

## The AvailableOperativeProcessActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableOperativeProcessActions":{"properties":{"actions":{"description":"List of available actions for the operative process","items":{"$ref":"#/components/schemas/AvailableOperativeProcessAction"},"type":"array"}},"required":["actions"],"title":"AvailableOperativeProcessActions","type":"object","description":"AvailableOperativeProcessActions"},"AvailableOperativeProcessAction":{"properties":{"available":{"description":"Indicates whether the action is available for this operative process","type":"boolean"},"denyReasons":{"description":"List of reasons why the action is not available","items":{"$ref":"#/components/schemas/AvailableOperativeProcessActionDenyReason"},"type":"array"},"name":{"description":"Name of the operative process action","enum":["REJECT_OPERATIVE_PROCESS","MANIPULATE_LINE_ITEM_QUANTITY","CHANGE_POSTAL_ADDRESS","ADD_TARGET_TIME"],"type":"string"}},"required":["name","available","denyReasons"],"title":"AvailableOperativeProcessAction","type":"object","description":"AvailableOperativeProcessAction"},"AvailableOperativeProcessActionDenyReason":{"properties":{"errorCode":{"description":"Error code indicating the reason why the action is not available","enum":["PICKING_STARTED","TRANSFER_HAPPENED","HANDOVER_DONE","TARGET_TIME_ALREADY_SET"],"type":"string"},"message":{"description":"Human-readable message describing the deny reason","type":"string"}},"required":["errorCode","message"],"title":"AvailableOperativeProcessActionDenyReason","type":"object","description":"AvailableOperativeProcessActionDenyReason"}}}}
```

## The AvailableRefusedReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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"],"type":"object","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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AvailableRefuseReasonForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableRefuseReasonForCreation":{"additionalProperties":false,"properties":{"refusedReasonLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized reason"},"active":{"type":"boolean"}},"required":["active","refusedReasonLocalized"],"type":"object","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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AvailableRefuseReasonForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableRefuseReasonForUpdate":{"additionalProperties":false,"properties":{"refusedReasonLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized reason"},"active":{"type":"boolean"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"number"}},"required":["active","refusedReasonLocalized","version"],"type":"object","title":"AvailableRefuseReasonForUpdate","description":"AvailableRefuseReasonForUpdate"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AvailableReturnReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableReturnReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"identifier":{"description":"Small identifier to be displayed and printed. Allowed values are 1-99 and A-Z. Needs to be unique respecting all other reasons. If not set, an ascending will be chosen automatically","type":"string"}},"required":["reasonLocalized"],"title":"AvailableReturnReason","type":"object","description":"AvailableReturnReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The AvailableUntilCalculationBase object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"}}}}
```

## The AvailableUntilDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"}}}}
```

## The BackofficePickingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BackofficePickingConfiguration":{"description":"Can this tenant use the backoffice for picking?","properties":{"active":{"default":false,"type":"boolean"}},"required":["active"],"type":"object","title":"BackofficePickingConfiguration"}}}}
```

## The Backordered object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Backordered":{"properties":{"lineItems":{"items":{"$ref":"#/components/schemas/DeliveryPromiseLineItem"},"type":"array"}},"required":["lineItems"],"type":"object","title":"Backordered","description":"Backordered"},"DeliveryPromiseLineItem":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DeliveryPromiseLineItem","description":"DeliveryPromiseLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"}}}}
```

## The BaseDecisionDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"}}}}
```

## The BaseOperationalContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"}}}}
```

## The BasePriceCostDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The BaseValidation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"}}}}
```

## The BasicDeliveryPromiseShipment object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BasicDeliveryPromiseShipment":{"additionalProperties":false,"properties":{"facility":{"$ref":"#/components/schemas/BasicDeliveryPromiseShipmentFacility"},"lineItems":{"items":{"$ref":"#/components/schemas/DeliveryPromiseLineItem"},"type":"array"}},"required":["lineItems","facility"],"type":"object","xml":{"name":"DeliveryPromiseShipment"},"title":"BasicDeliveryPromiseShipment","description":"BasicDeliveryPromiseShipment"},"BasicDeliveryPromiseShipmentFacility":{"additionalProperties":false,"properties":{"facilityName":{"type":"string"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityName","facilityRef"],"title":"BasicDeliveryPromiseShipmentFacility","description":"BasicDeliveryPromiseShipmentFacility"},"DeliveryPromiseLineItem":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DeliveryPromiseLineItem","description":"DeliveryPromiseLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"}}}}
```

## The BasicDeliveryPromiseShipmentFacility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BasicDeliveryPromiseShipmentFacility":{"additionalProperties":false,"properties":{"facilityName":{"type":"string"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityName","facilityRef"],"title":"BasicDeliveryPromiseShipmentFacility","description":"BasicDeliveryPromiseShipmentFacility"}}}}
```

## The BasketItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BasketItem":{"properties":{"quantity":{"description":"Quantity","type":"integer"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","quantity"],"title":"BasketItem","type":"object","description":"BasketItem"}}}}
```

## The BatchPickingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BatchPickingConfiguration":{"additionalProperties":false,"properties":{"maxAmountOfPickJobsForBatchPick":{"description":"The maximum amount of pick jobs that can be combined in a batch pick. Must be a value between 1 and 100.","maximum":100,"minimum":1,"type":"integer"}},"required":["maxAmountOfPickJobsForBatchPick"],"type":"object","title":"BatchPickingConfiguration","description":"BatchPickingConfiguration"}}}}
```

## The BinPackerInput object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BinPackerInput":{"properties":{"currency":{"description":"ISO 4217 currency code","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"lineItems":{"description":"List of articles and quantities to pack","items":{"$ref":"#/components/schemas/BinPackerInputOrderLine"},"minItems":1,"type":"array"},"packagingUnitDetailRefs":{"description":"List of packaging unit detail references to consider for packing","items":{"type":"string"},"minItems":1,"type":"array"},"sourceFacilityRef":{"description":"Reference to the source facility","type":"string"},"targetCountryCode":{"description":"ISO 3166-1 alpha-2 country code of the target location","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"targetPostalCode":{"description":"Postal code of the target location","nullable":true,"type":"string"}},"required":["lineItems","packagingUnitDetailRefs","sourceFacilityRef","targetCountryCode","currency"],"title":"BinPackerInput","type":"object","description":"BinPackerInput"},"BinPackerInputOrderLine":{"properties":{"quantity":{"description":"Number of items of this article to pack","minimum":1,"type":"number"},"tenantArticleId":{"description":"Unique identifier for the article within the tenant","type":"string"}},"required":["tenantArticleId","quantity"],"title":"BinPackerInputOrderLine","type":"object","description":"BinPackerInputOrderLine"}}}}
```

## The BinPackerInputOrderLine object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BinPackerInputOrderLine":{"properties":{"quantity":{"description":"Number of items of this article to pack","minimum":1,"type":"number"},"tenantArticleId":{"description":"Unique identifier for the article within the tenant","type":"string"}},"required":["tenantArticleId","quantity"],"title":"BinPackerInputOrderLine","type":"object","description":"BinPackerInputOrderLine"}}}}
```

## The BooleanFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"}}}}
```

## The Brand object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Brand":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BrandForCreation"}],"properties":{"id":{"type":"string"},"name":{"description":"The name of the brand for this listing","type":"string"}},"required":["name","id"],"type":"object","xml":{"name":"Brand"},"title":"Brand","description":"Brand"},"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"},"BrandForCreation":{"properties":{"name":{"description":"The name of the brand for this listing","type":"string"}},"required":["name"],"type":"object","xml":{"name":"BrandForCreation"},"title":"BrandForCreation","description":"BrandForCreation"}}}}
```

## The BrandForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BrandForCreation":{"properties":{"name":{"description":"The name of the brand for this listing","type":"string"}},"required":["name"],"type":"object","xml":{"name":"BrandForCreation"},"title":"BrandForCreation","description":"BrandForCreation"}}}}
```

## The BringCarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BringCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customerId":{"description":"Customer ID for Bring carrier","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"returnProduct":{"description":"Return product code","type":"string"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"shipmentProduct":{"description":"Shipment product code","type":"string"},"supportPhoneNumber":{"description":"Support phone number","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"},"webhookFftHost":{"description":"Webhook FFT host","type":"string"}},"required":["version","carrierRef","returnLabel","customerId","supportPhoneNumber"],"title":"BringCarrierConfiguration","type":"object","description":"BringCarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The BulkCancelOrderParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkCancelOrderParameter":{"properties":{"cancelationReasonId":{"description":"ID of the cancellation reason","type":"string"},"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkCancelOrderParameter","description":"BulkCancelOrderParameter"}}}}
```

## The BulkForceCancelOrderParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkForceCancelOrderParameter":{"properties":{"cancelationReasonId":{"description":"ID of the cancellation reason","type":"string"},"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkForceCancelOrderParameter","description":"BulkForceCancelOrderParameter"}}}}
```

## The BulkInvalidatePromiseOrderActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkInvalidatePromiseOrderActionParameter":{"description":"Action to invalidate promise orders.","properties":{"name":{"enum":["BULK_INVALIDATE_PROMISE"],"type":"string"},"orders":{"items":{"$ref":"#/components/schemas/BulkPromiseOrderParameter"},"maxItems":15,"minItems":1,"type":"array"}},"required":["name","orders"],"title":"BulkInvalidatePromisedOrderActionParameter"},"BulkPromiseOrderParameter":{"properties":{"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkPromiseOrderParameter","description":"BulkPromiseOrderParameter"}}}}
```

## The BulkOperationError object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkOperationError":{"properties":{"message":{"type":"string"},"type":{"enum":["NOT_FOUND","NOT_ALLOWED","VALIDATION","UNKNOWN"],"type":"string"}},"required":["type","message"],"title":"BulkOperationError","type":"object","description":"BulkOperationError"}}}}
```

## The BulkOperationResultStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkOperationResultStatus":{"enum":["UPDATED","UNCHANGED","CREATED","FAILED"],"type":"string","title":"BulkOperationResultStatus","description":"BulkOperationResultStatus"}}}}
```

## The BulkOrderActionResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkOrderActionResult":{"properties":{"orderId":{"type":"string"},"status":{"$ref":"#/components/schemas/BulkOperationResultStatus"},"summary":{"type":"string"}},"required":["orderId","status"],"type":"object","title":"BulkOrderActionResult","description":"BulkOrderActionResult"},"BulkOperationResultStatus":{"enum":["UPDATED","UNCHANGED","CREATED","FAILED"],"type":"string","title":"BulkOperationResultStatus","description":"BulkOperationResultStatus"}}}}
```

## The BulkOrderActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkOrderActionsParameter":{"oneOf":[{"$ref":"#/components/schemas/BulkOrderForceCancelActionParameter"},{"$ref":"#/components/schemas/BulkOrderCancelActionParameter"},{"$ref":"#/components/schemas/BulkOrderUnlockActionParameter"},{"$ref":"#/components/schemas/BulkInvalidatePromiseOrderActionParameter"}],"title":"BulkOrderActionsParameter","description":"BulkOrderActionsParameter"},"BulkOrderForceCancelActionParameter":{"description":"Action to force cancel orders.","properties":{"name":{"enum":["BULK_FORCE_CANCEL"],"type":"string"},"orders":{"items":{"$ref":"#/components/schemas/BulkForceCancelOrderParameter"},"maxItems":15,"minItems":1,"type":"array"}},"required":["name","orders"],"title":"BulkOrderForceCancelActionParameter"},"BulkForceCancelOrderParameter":{"properties":{"cancelationReasonId":{"description":"ID of the cancellation reason","type":"string"},"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkForceCancelOrderParameter","description":"BulkForceCancelOrderParameter"},"BulkOrderCancelActionParameter":{"description":"Action to cancel orders.","properties":{"name":{"enum":["BULK_CANCEL"],"type":"string"},"orders":{"items":{"$ref":"#/components/schemas/BulkCancelOrderParameter"},"maxItems":15,"minItems":1,"type":"array"}},"required":["name","orders"],"title":"BulkOrderCancelActionParameter"},"BulkCancelOrderParameter":{"properties":{"cancelationReasonId":{"description":"ID of the cancellation reason","type":"string"},"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkCancelOrderParameter","description":"BulkCancelOrderParameter"},"BulkOrderUnlockActionParameter":{"description":"Action to unlock orders.","properties":{"name":{"enum":["BULK_UNLOCK"],"type":"string"},"orders":{"items":{"$ref":"#/components/schemas/BulkUnlockOrderParameter"},"maxItems":15,"minItems":1,"type":"array"}},"required":["name","orders"],"title":"BulkOrderUnlockActionParameter"},"BulkUnlockOrderParameter":{"properties":{"orderId":{"type":"string"},"targetTime":{"description":"Time to be set as a targetTime for the delivery preferences.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkUnlockOrderParameter","description":"BulkUnlockOrderParameter"},"BulkInvalidatePromiseOrderActionParameter":{"description":"Action to invalidate promise orders.","properties":{"name":{"enum":["BULK_INVALIDATE_PROMISE"],"type":"string"},"orders":{"items":{"$ref":"#/components/schemas/BulkPromiseOrderParameter"},"maxItems":15,"minItems":1,"type":"array"}},"required":["name","orders"],"title":"BulkInvalidatePromisedOrderActionParameter"},"BulkPromiseOrderParameter":{"properties":{"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkPromiseOrderParameter","description":"BulkPromiseOrderParameter"}}}}
```

## The BulkOrderCancelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkOrderCancelActionParameter":{"description":"Action to cancel orders.","properties":{"name":{"enum":["BULK_CANCEL"],"type":"string"},"orders":{"items":{"$ref":"#/components/schemas/BulkCancelOrderParameter"},"maxItems":15,"minItems":1,"type":"array"}},"required":["name","orders"],"title":"BulkOrderCancelActionParameter"},"BulkCancelOrderParameter":{"properties":{"cancelationReasonId":{"description":"ID of the cancellation reason","type":"string"},"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkCancelOrderParameter","description":"BulkCancelOrderParameter"}}}}
```

## The BulkOrderForceCancelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkOrderForceCancelActionParameter":{"description":"Action to force cancel orders.","properties":{"name":{"enum":["BULK_FORCE_CANCEL"],"type":"string"},"orders":{"items":{"$ref":"#/components/schemas/BulkForceCancelOrderParameter"},"maxItems":15,"minItems":1,"type":"array"}},"required":["name","orders"],"title":"BulkOrderForceCancelActionParameter"},"BulkForceCancelOrderParameter":{"properties":{"cancelationReasonId":{"description":"ID of the cancellation reason","type":"string"},"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkForceCancelOrderParameter","description":"BulkForceCancelOrderParameter"}}}}
```

## The BulkOrderUnlockActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkOrderUnlockActionParameter":{"description":"Action to unlock orders.","properties":{"name":{"enum":["BULK_UNLOCK"],"type":"string"},"orders":{"items":{"$ref":"#/components/schemas/BulkUnlockOrderParameter"},"maxItems":15,"minItems":1,"type":"array"}},"required":["name","orders"],"title":"BulkOrderUnlockActionParameter"},"BulkUnlockOrderParameter":{"properties":{"orderId":{"type":"string"},"targetTime":{"description":"Time to be set as a targetTime for the delivery preferences.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkUnlockOrderParameter","description":"BulkUnlockOrderParameter"}}}}
```

## The BulkPromiseOrderParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkPromiseOrderParameter":{"properties":{"orderId":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkPromiseOrderParameter","description":"BulkPromiseOrderParameter"}}}}
```

## The BulkUnlockOrderParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkUnlockOrderParameter":{"properties":{"orderId":{"type":"string"},"targetTime":{"description":"Time to be set as a targetTime for the delivery preferences.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["orderId","version"],"type":"object","title":"BulkUnlockOrderParameter","description":"BulkUnlockOrderParameter"}}}}
```

## The BulkUpsertSummary object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkUpsertSummary":{"properties":{"created":{"description":"The number of operations that led to an insertion","type":"number"},"unchanged":{"description":"The number of operations that led to no change","type":"number"},"updated":{"description":"The number of operations that led to an update","type":"number"}},"required":["created","updated","unchanged"],"title":"BulkUpsertSummary","type":"object","description":"BulkUpsertSummary"}}}}
```

## The BulkyGoodsDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BulkyGoodsDetails":{"properties":{"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxGirth":{"description":"The maximum girth in millimeters of the packagingUnit.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxLength":{"description":"The maximum length in millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","maxLength","maxGirth","maxWeight","packagingPricingDetails"],"title":"BulkyGoodsDetails","type":"object","description":"BulkyGoodsDetails"},"PackagingPricingDetails":{"properties":{"costCoefficient":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitCostCoefficient"}],"description":"Cost coefficient for two-man handling"},"pricing":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricingByZone"},"maxItems":500,"type":"array"},"surchargesPerPackagingUnits":{"description":"The surcharge applied per packagingUnit.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackagingUnitDetailRelativeSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"}]},"maxItems":500,"type":"array"}},"required":["pricing"],"title":"PackagingPricingDetails","type":"object","description":"PackagingPricingDetails"},"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"},"PackagingUnitPricingBasis":{"properties":{"pricingQuantities":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","items":{"$ref":"#/components/schemas/PackagingUnitPricingQuantity"},"maxItems":3,"type":"array"},"pricingUnit":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingUnit"}],"description":"The unit the pricing quantities are converted to and priced in."}},"required":["pricingUnit","pricingQuantities"],"title":"PackagingUnitPricingBasis","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />PackagingUnitPricingBasis"},"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"},"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"}}}}
```

## The BundleInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"BundleInformation":{"properties":{"customServiceNodeId":{"type":"string"},"requestedQuantity":{"type":"number"}},"required":["customServiceNodeId","requestedQuantity"],"title":"BundleInformation","description":"BundleInformation"}}}}
```

## The ByTrait object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"ByTrait","type":"object","description":"ByTrait"}}}}
```

## The CalculatedPurchasePrice object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CalculatedPurchasePrice":{"properties":{"discount":{"description":"The discount applied to the purchase price","oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"discountedPurchasePrice":{"allOf":[{"$ref":"#/components/schemas/PurchasePrice"}],"description":"Discounted purchase price for the listing."},"purchasePrice":{"allOf":[{"$ref":"#/components/schemas/PurchasePrice"}],"description":"purchase price information for the listing."},"supplierFacilityRef":{"description":"The reference of the supplier facility.","type":"string"}},"required":["supplierFacilityRef","purchasePrice","discountedPurchasePrice"],"title":"CalculatedPurchasePrice","type":"object","description":"CalculatedPurchasePrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PurchasePrice":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"The currency of the purchase price."},"decimalPlaces":{"description":"The number of decimal places for the purchase price.","type":"number"},"value":{"description":"The value of the purchase price.","type":"number"}},"required":["value","currency","decimalPlaces"],"title":"PurchasePrice","type":"object","description":"PurchasePrice"}}}}
```

## The CallbackHeader object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CallbackHeader":{"description":"Header for the Webhook call.","properties":{"key":{"description":"This is the key of the header. e.g.: `Authorization`","type":"string"},"value":{"description":"This is the value for the header. e.g.: `Basic dXNlcm5hbWU6cGFzc3dvcmQ=`","type":"string"}},"required":["key","value"],"title":"CallbackHeader","type":"object"}}}}
```

## The CancelationReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The CancelationReasonForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelationReasonForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"}],"type":"object","xml":{"name":"CancelationReasonForCreation"},"title":"CancelationReasonForCreation","description":"CancelationReasonForCreation"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The CancelationReasonForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelationReasonForModification":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForModification"}],"type":"object","xml":{"name":"CancelationReasonForModification"},"title":"CancelationReasonForModification","description":"CancelationReasonForModification"},"AbstractReasonForModification":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForModification"},"title":"AbstractReasonForModification","description":"AbstractReasonForModification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The CancelationReasonHistoryLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The CancelationReasons object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelationReasons":{"allOf":[{"$ref":"#/components/schemas/AbstractReasons"}],"properties":{"reasons":{"items":{"$ref":"#/components/schemas/CancelationReason"},"type":"array"}},"required":["reasons"],"type":"object","xml":{"name":"CancelationReasons"},"title":"CancelationReasons","description":"CancelationReasons"},"AbstractReasons":{"properties":{"hasNextPage":{"description":"True if there are more results after the current page","type":"boolean"},"reasons":{"items":{"$ref":"#/components/schemas/AbstractReason"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"required":["reasons","hasNextPage","total"],"type":"object","xml":{"name":"AbstractReasons"},"title":"AbstractReasons","description":"AbstractReasons"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"}}}}
```

## The CancelHandoverjob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelHandoverjob":{"additionalProperties":false,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/handoverjobs/:id/actions instead","properties":{"action":{"$ref":"#/components/schemas/CancelHandoverjobActionEnum"},"handoverJobCancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"}},"required":["action","handoverJobCancelReason"],"title":"CancelHandoverjob","type":"object","xml":{"name":"CancelHandoverjob"}},"CancelHandoverjobActionEnum":{"enum":["CancelHandoverjob"],"type":"string","title":"CancelHandoverjobActionEnum","description":"CancelHandoverjobActionEnum"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"}}}}
```

## The CancelHandoverjobActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelHandoverjobActionEnum":{"enum":["CancelHandoverjob"],"type":"string","title":"CancelHandoverjobActionEnum","description":"CancelHandoverjobActionEnum"}}}}
```

## The CancelItemReturnActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelItemReturnActionParameter":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"enum":["CancelItemReturn"],"type":"string"}},"required":["name","itemReturnJobVersion"],"title":"CancelItemReturnActionParameter","type":"object","description":"CancelItemReturnActionParameter"}}}}
```

## The CancelPickRun object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelPickRun":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'CancelPickRun', because you want to cancel a pickrun","enum":["CancelPickRun"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickruns/:id/actions instead","title":"CancelPickRun","xml":{"name":"CancelPickRun"}}}}}
```

## The CancelStowJobAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CancelStowJobAction":{"description":"Sets the status of the stowjob to CANCELED","properties":{"name":{"description":"The name of the action that should be performed","enum":["CANCEL_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"CancelStowJobAction","type":"object"}}}}
```

## The CapabilityStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CapabilityStatus":{"enum":["enabled","inactive","disabled"],"type":"string","title":"CapabilityStatus","description":"CapabilityStatus"}}}}
```

## The CapacityPlanningTimeframeConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CapacityPlanningTimeframeConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"days":{"default":100,"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"id":{"type":"string"}},"required":["days"],"type":"object","title":"CapacityPlanningTimeframeConfiguration","description":"CapacityPlanningTimeframeConfiguration"},"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"}}}}
```

## The Carrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Carrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP. Default: DELIVERY","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassification"},"type":"array"},"productValueNeeded":{"description":"Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","key","name","defaultParcelWidthInCm","defaultParcelLengthInCm","defaultParcelHeightInCm"],"title":"Carrier","type":"object","description":"Carrier"},"AbstractCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractCarrierCredentials","type":"object","description":"AbstractCarrierCredentials"},"ParcelLabelClassification":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"name":{"description":"Name of the parcel label classification","type":"string"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassification","type":"object","description":"ParcelLabelClassification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"}}}}
```

## The CarrierChangedCarrierInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierChangedCarrierInfo":{"properties":{"carrierKey":{"type":"string"},"carrierRef":{"type":"string"}},"type":"object","title":"CarrierChangedCarrierInfo","description":"CarrierChangedCarrierInfo"}}}}
```

## The CarrierChangedPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierChangedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"newCarrier":{"$ref":"#/components/schemas/CarrierChangedCarrierInfo"},"previousCarrier":{"$ref":"#/components/schemas/CarrierChangedCarrierInfo"}},"type":"object","title":"CarrierChangedPayload","description":"CarrierChangedPayload"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"CarrierChangedCarrierInfo":{"properties":{"carrierKey":{"type":"string"},"carrierRef":{"type":"string"}},"type":"object","title":"CarrierChangedCarrierInfo","description":"CarrierChangedCarrierInfo"}}}}
```

## The CarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"CarrierConfiguration","type":"object","description":"CarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The CarrierCountryServiceMapping object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The CarrierCountryServiceMappingForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierCountryServiceMappingForCreation":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process. Mandatory fields can not be additional. If duplicates found, the additional values will be removed on read.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"minItems":0,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process. Mandatory fields can not be additional If duplicates found, the additional values will be removed on read.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"minItems":0,"type":"array"},"carrierConfigurationVersion":{"description":"The version of the carrier configuration to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"minItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destination instead.","items":{"type":"string"},"minItems":1,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"minItems":1,"type":"array"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"minItems":0,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"minItems":0,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"minItems":0,"type":"array"},"products":{"description":"Products for this mapping","items":{"type":"string"},"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","maxLength":2,"minLength":2,"type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["carrierConfigurationVersion","source","destinations"],"title":"CarrierCountryServiceMappingForCreation","type":"object","description":"CarrierCountryServiceMappingForCreation"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The CarrierCountryServiceMappingForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierCountryServiceMappingForUpdate":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process. Mandatory fields can not be additional. If duplicates found, the additional values will be removed on read.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"minItems":0,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process. Mandatory fields can not be additional If duplicates found, the additional values will be removed on read.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"minItems":0,"type":"array"},"carrierConfigurationVersion":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destination instead.","items":{"type":"string"},"minItems":1,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"minItems":1,"type":"array"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"minItems":0,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"minItems":0,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"minItems":0,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","maxLength":2,"minLength":2,"type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["carrierConfigurationVersion"],"title":"CarrierCountryServiceMappingForUpdate","type":"object","description":"CarrierCountryServiceMappingForUpdate"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The CarrierCutoffConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"}}}}
```

## The CarrierCutoffTimes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"}}}}
```

## The CarrierCutoffTimesOverwrite object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"}}}}
```

## The CarrierCutoffTimesWeekDay object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"}}}}
```

## The CarrierDeliveryType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierDeliveryType":{"enum":["SAMEDAY","DELIVERY"],"type":"string","title":"CarrierDeliveryType","description":"CarrierDeliveryType"}}}}
```

## The CarrierForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierForCreation":{"properties":{"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"key":{"description":"References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.","type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassificationForCreation"},"type":"array"},"productValueNeeded":{"description":"Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["key","name"],"title":"CarrierForCreation","type":"object","description":"CarrierForCreation"},"AbstractCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractCarrierCredentials","type":"object","description":"AbstractCarrierCredentials"},"ParcelLabelClassificationForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassificationForCreation","type":"object","description":"ParcelLabelClassificationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"}}}}
```

## The CarrierPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierPatchActions":{"properties":{"actions":{"description":"Array of modification actions to apply to the carrier","items":{"$ref":"#/components/schemas/ModifyCarrier"},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["actions","version"],"title":"CarrierPatchActions","type":"object","description":"CarrierPatchActions"},"ModifyCarrier":{"properties":{"action":{"description":"Use value 'ModifyCarrier', because you want to modify a carrier","enum":["ModifyCarrier"],"type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractModifyCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP","enum":["SAMEDAY","DELIVERY"],"type":"string"},"lifecycle":{"description":"Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet.","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassificationForCreation"},"type":"array"},"productValueNeeded":{"description":"Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers","enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["action"],"title":"ModifyCarrier","type":"object","description":"ModifyCarrier"},"AbstractModifyCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractModifyCarrierCredentials","type":"object","description":"AbstractModifyCarrierCredentials"},"ParcelLabelClassificationForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassificationForCreation","type":"object","description":"ParcelLabelClassificationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"}}}}
```

## The CarrierPickUpTime object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"}}}}
```

## The CarrierPriorityCalculationRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierPriorityCalculationRequest":{"properties":{"productValue":{"$ref":"#/components/schemas/ParcelProductValue","description":"Product value information used to calculate carrier priority"}},"title":"CarrierPriorityCalculationRequest","type":"object","description":"CarrierPriorityCalculationRequest"},"ParcelProductValue":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"ParcelProductValue","description":"ParcelProductValue"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The CarrierPriorityResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierPriorityResult":{"properties":{"otherCarriers":{"description":"Other eligible carriers ordered by priority","items":{"$ref":"#/components/schemas/CarrierRecommendationResult"},"type":"array"},"recommendedCarriers":{"description":"Recommended carriers ordered by priority (best first)","items":{"$ref":"#/components/schemas/CarrierRecommendationResult"},"type":"array"}},"required":["recommendedCarriers","otherCarriers"],"title":"CarrierPriorityResult","type":"object","description":"CarrierPriorityResult"},"CarrierRecommendationResult":{"properties":{"carrier":{"$ref":"#/components/schemas/Carrier","description":"Carrier that is recommended"},"priority":{"description":"Calculated priority value (lower typically indicates a better match)","type":"number"},"threshold":{"$ref":"#/components/schemas/PriceRange","description":"Applicable price threshold for this recommendation"}},"required":["priority","carrier"],"title":"CarrierRecommendationResult","type":"object","description":"CarrierRecommendationResult"},"Carrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP. Default: DELIVERY","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassification"},"type":"array"},"productValueNeeded":{"description":"Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","key","name","defaultParcelWidthInCm","defaultParcelLengthInCm","defaultParcelHeightInCm"],"title":"Carrier","type":"object","description":"Carrier"},"AbstractCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractCarrierCredentials","type":"object","description":"AbstractCarrierCredentials"},"ParcelLabelClassification":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"name":{"description":"Name of the parcel label classification","type":"string"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassification","type":"object","description":"ParcelLabelClassification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The CarrierProductCategory object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"}}}}
```

## The CarrierRecipientInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierRecipientInformation":{"properties":{"address":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":3,"minItems":1,"type":"array"},"id":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","type":"string"}},"required":["id","address"],"title":"CarrierRecipientInformation","type":"object","description":"CarrierRecipientInformation"},"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"},"maxItems":500,"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"}}}}
```

## The CarrierRecipientInformationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierRecipientInformationForCreation":{"properties":{"address":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":3,"minItems":1,"type":"array"}},"required":["address"],"title":"CarrierRecipientInformationForCreation","type":"object","description":"CarrierRecipientInformationForCreation"},"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"},"maxItems":500,"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"}}}}
```

## The CarrierRecommendationResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierRecommendationResult":{"properties":{"carrier":{"$ref":"#/components/schemas/Carrier","description":"Carrier that is recommended"},"priority":{"description":"Calculated priority value (lower typically indicates a better match)","type":"number"},"threshold":{"$ref":"#/components/schemas/PriceRange","description":"Applicable price threshold for this recommendation"}},"required":["priority","carrier"],"title":"CarrierRecommendationResult","type":"object","description":"CarrierRecommendationResult"},"Carrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP. Default: DELIVERY","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassification"},"type":"array"},"productValueNeeded":{"description":"Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","key","name","defaultParcelWidthInCm","defaultParcelLengthInCm","defaultParcelHeightInCm"],"title":"Carrier","type":"object","description":"Carrier"},"AbstractCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractCarrierCredentials","type":"object","description":"AbstractCarrierCredentials"},"ParcelLabelClassification":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"name":{"description":"Name of the parcel label classification","type":"string"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassification","type":"object","description":"ParcelLabelClassification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The CarrierService object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"}}}}
```

## The CarrierServices object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"}}}}
```

## The CarrierStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierStatus":{"description":"It is taken into consideration for all carriers. Default: INACTIVE","enum":["ACTIVE","INACTIVE"],"type":"string","title":"CarrierStatus"}}}}
```

## The CarrierTrackingStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"type":"object","title":"CarrierTrackingStatus"}}}}
```

## The CarrierTransitTime object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The Category object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"}}}}
```

## The CategoryForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CategoryForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"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"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"}},"required":["nameLocalized"],"title":"CategoryForCreation","type":"object","description":"CategoryForCreation"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"}}}}
```

## The CategoryForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CategoryForUpdate":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"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"},"id":{"type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version"],"title":"CategoryForUpdate","type":"object","description":"CategoryForUpdate"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"}}}}
```

## The CategoryPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CategoryPaginatedResult":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/Category"},"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","categories"],"title":"CategoryPaginatedResult","type":"object","description":"CategoryPaginatedResult"},"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"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"}}}}
```

## The CategorySearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CategorySearchPayload":{"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/CategorySearchQuery"},"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/CategorySort"},"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":"CategorySearchPayload","type":"object","description":"CategorySearchPayload"},"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"},"CategorySearchQuery":{"properties":{"nameLocalized":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by nameLocalized","type":"object"},"and":{"items":{"$ref":"#/components/schemas/CategorySearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/CategorySearchQuery"},"maxItems":500,"type":"array"},"tenantCategoryId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantCategoryId"}},"title":"CategorySearchQuery","type":"object","description":"CategorySearchQuery"},"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"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"LocalizedStringSearchFilter":{"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":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"},"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"},"CategorySort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"id":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantCategoryId":{"enum":["ASC","DESC"],"type":"string"}},"title":"CategorySort","type":"object","description":"CategorySort"}}}}
```

## The CategorySearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CategorySearchQuery":{"properties":{"nameLocalized":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by nameLocalized","type":"object"},"and":{"items":{"$ref":"#/components/schemas/CategorySearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/CategorySearchQuery"},"maxItems":500,"type":"array"},"tenantCategoryId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantCategoryId"}},"title":"CategorySearchQuery","type":"object","description":"CategorySearchQuery"},"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"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"LocalizedStringSearchFilter":{"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":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"},"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"}}}}
```

## The CategorySort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CategorySort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"id":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantCategoryId":{"enum":["ASC","DESC"],"type":"string"}},"title":"CategorySort","type":"object","description":"CategorySort"}}}}
```

## The ChangeLineItemsToNotReturnableInItemReturnJobActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ChangeLineItemsToNotReturnableInItemReturnJobActionParameter":{"properties":{"lineItemIds":{"items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"name":{"enum":["CHANGE_LINE_ITEMS_TO_NOT_RETURNABLE_IN_ITEM_RETURN_JOB"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","name","lineItemIds"],"title":"ChangeLineItemsToNotReturnableInItemReturnJobActionParameter","type":"object","description":"ChangeLineItemsToNotReturnableInItemReturnJobActionParameter"}}}}
```

## The ChangeLineItemsToReturnableInItemReturnJobActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ChangeLineItemsToReturnableInItemReturnJobActionParameter":{"properties":{"lineItemIds":{"items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"name":{"enum":["CHANGE_LINE_ITEMS_TO_RETURNABLE_IN_ITEM_RETURN_JOB"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","name","lineItemIds"],"title":"ChangeLineItemsToReturnableInItemReturnJobActionParameter","type":"object","description":"ChangeLineItemsToReturnableInItemReturnJobActionParameter"}}}}
```

## The ChannelStockAvailability object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ChannelStockAvailability":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"channelRef":{"type":"string"}},"required":["channelRef","availableForPicking","availableOnStock"],"title":"ChannelStockAvailability","type":"object","description":"ChannelStockAvailability"}}}}
```

## The CheckoutOptionsAvailability object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsAvailability":{"properties":{"available":{"description":"Available quantity","type":"number"},"carrier":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsAvailabilityCarrier"}],"description":"Carrier details"},"isBackOrderable":{"description":"Is item back-orderable","type":"boolean"},"latestPickingStart":{"description":"Latest picking start","format":"date-time","type":"string"},"preOrderReleaseDate":{"description":"Pre-order release date","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","available","isBackOrderable"],"title":"CheckoutOptionsAvailability","type":"object","description":"CheckoutOptionsAvailability"},"CheckoutOptionsAvailabilityCarrier":{"properties":{"carrierProductCategory":{"description":"Carrier product category","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierRef":{"description":"Carrier reference","type":"string"}},"required":["carrierRef"],"title":"CheckoutOptionsAvailabilityCarrier","type":"object","description":"CheckoutOptionsAvailabilityCarrier"}}}}
```

## The CheckoutOptionsAvailabilityCarrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsAvailabilityCarrier":{"properties":{"carrierProductCategory":{"description":"Carrier product category","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierRef":{"description":"Carrier reference","type":"string"}},"required":["carrierRef"],"title":"CheckoutOptionsAvailabilityCarrier","type":"object","description":"CheckoutOptionsAvailabilityCarrier"}}}}
```

## The CheckoutOptionsCollectEarliestRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsCollectEarliestRequest":{"properties":{"desiredCollectDate":{"description":"Desired collection date","format":"date-time","type":"string"},"facilities":{"description":"List of facilities for collection. Each item must contain exactly one of facilityRef or tenantFacilityRef.","items":{"oneOf":[{"$ref":"#/components/schemas/CheckoutOptionsCollectFacilitiesFacilityRef"},{"$ref":"#/components/schemas/CheckoutOptionsCollectFacilitiesTenantFacilityRef"}]},"type":"array"},"includeCalculationHints":{"description":"Whether to include calculation hints in the response","type":"boolean"},"tenantArticleIds":{"description":"List of tenant article IDs","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["tenantArticleIds"],"title":"CheckoutOptionsCollectEarliestRequest","type":"object","description":"CheckoutOptionsCollectEarliestRequest"},"CheckoutOptionsCollectFacilitiesFacilityRef":{"properties":{"facilityRef":{"description":"Facility reference","type":"string"}},"required":["facilityRef"],"title":"CheckoutOptionsCollectFacilitiesFacilityRef","type":"object","description":"CheckoutOptionsCollectFacilitiesFacilityRef"},"CheckoutOptionsCollectFacilitiesTenantFacilityRef":{"properties":{"tenantFacilityRef":{"description":"Tenant facility reference","type":"string"}},"required":["tenantFacilityRef"],"title":"CheckoutOptionsCollectFacilitiesTenantFacilityRef","type":"object","description":"CheckoutOptionsCollectFacilitiesTenantFacilityRef"}}}}
```

## The CheckoutOptionsCollectEarliestResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsCollectEarliestResponse":{"properties":{"calculationHints":{"description":"Calculation hints","items":{"type":"string"},"type":"array"},"checkoutOptions":{"description":"Checkout options per article for collection","items":{"$ref":"#/components/schemas/CheckoutOptionsCollectEarliestResponseItem"},"type":"array"}},"required":["checkoutOptions"],"title":"CheckoutOptionsCollectEarliestResponse","type":"object","description":"CheckoutOptionsCollectEarliestResponse"},"CheckoutOptionsCollectEarliestResponseItem":{"properties":{"available":{"description":"Available quantity","type":"number"},"earliestPredictedProvisioningDate":{"description":"Earliest predicted provisioning date","format":"date-time","type":"string"},"facilityRef":{"description":"Facility reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"},"tenantFacilityId":{"description":"Tenant facility ID","type":"string"}},"required":["tenantArticleId"],"title":"CheckoutOptionsCollectEarliestResponseItem","type":"object","description":"CheckoutOptionsCollectEarliestResponseItem"}}}}
```

## The CheckoutOptionsCollectEarliestResponseItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsCollectEarliestResponseItem":{"properties":{"available":{"description":"Available quantity","type":"number"},"earliestPredictedProvisioningDate":{"description":"Earliest predicted provisioning date","format":"date-time","type":"string"},"facilityRef":{"description":"Facility reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"},"tenantFacilityId":{"description":"Tenant facility ID","type":"string"}},"required":["tenantArticleId"],"title":"CheckoutOptionsCollectEarliestResponseItem","type":"object","description":"CheckoutOptionsCollectEarliestResponseItem"}}}}
```

## The CheckoutOptionsCollectFacilitiesFacilityRef object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsCollectFacilitiesFacilityRef":{"properties":{"facilityRef":{"description":"Facility reference","type":"string"}},"required":["facilityRef"],"title":"CheckoutOptionsCollectFacilitiesFacilityRef","type":"object","description":"CheckoutOptionsCollectFacilitiesFacilityRef"}}}}
```

## The CheckoutOptionsCollectFacilitiesTenantFacilityRef object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsCollectFacilitiesTenantFacilityRef":{"properties":{"tenantFacilityRef":{"description":"Tenant facility reference","type":"string"}},"required":["tenantFacilityRef"],"title":"CheckoutOptionsCollectFacilitiesTenantFacilityRef","type":"object","description":"CheckoutOptionsCollectFacilitiesTenantFacilityRef"}}}}
```

## The CheckoutOptionsConsumerAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsConsumerAddress":{"properties":{"addressType":{"description":"Type of address","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"city":{"description":"City name","type":"string"},"country":{"description":"Country code","type":"string"},"houseNumber":{"description":"House number","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street name","type":"string"}},"required":["country"],"title":"CheckoutOptionsConsumerAddress","type":"object","description":"CheckoutOptionsConsumerAddress"}}}}
```

## The CheckoutOptionsCustomServices object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsCustomServices":{"properties":{"customServiceRef":{"description":"Custom service reference","type":"string"},"name":{"description":"Custom service name","type":"string"}},"required":["customServiceRef","name"],"title":"CheckoutOptionsCustomServices","type":"object","description":"CheckoutOptionsCustomServices"}}}}
```

## The CheckoutOptionsDeliveryEarliestRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryEarliestRequest":{"properties":{"consumerAddress":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsConsumerAddress"}],"description":"Consumer delivery address"},"earliestDeliveryDate":{"description":"Earliest delivery date","format":"date-time","type":"string"},"filter":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsFacilityFilter"}],"description":"Facility filter criteria"},"includeCalculationHints":{"description":"Whether to include calculation hints in the response","type":"boolean"},"includeListingDetails":{"description":"Indicates whether listing-related details should be included in the response. If set to `true`, the response contains additional listing details. Defaults to `false`.","type":"boolean"},"tenantArticleIds":{"description":"List of tenant article IDs","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["consumerAddress","tenantArticleIds"],"title":"CheckoutOptionsDeliveryEarliestRequest","type":"object","description":"CheckoutOptionsDeliveryEarliestRequest"},"CheckoutOptionsConsumerAddress":{"properties":{"addressType":{"description":"Type of address","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"city":{"description":"City name","type":"string"},"country":{"description":"Country code","type":"string"},"houseNumber":{"description":"House number","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street name","type":"string"}},"required":["country"],"title":"CheckoutOptionsConsumerAddress","type":"object","description":"CheckoutOptionsConsumerAddress"},"CheckoutOptionsFacilityFilter":{"properties":{"customAttributes":{"description":"Custom attributes for facility filtering","type":"object"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"title":"CheckoutOptionsFacilityFilter","type":"object","description":"CheckoutOptionsFacilityFilter"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The CheckoutOptionsDeliveryEarliestResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryEarliestResponse":{"properties":{"calculationHints":{"description":"Calculation hints for debugging","items":{"type":"string"},"type":"array"},"checkoutOptions":{"description":"List of checkout options for each article","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryEarliestResponseItem"},"type":"array"}},"required":["checkoutOptions"],"title":"CheckoutOptionsDeliveryEarliestResponse","type":"object","description":"CheckoutOptionsDeliveryEarliestResponse"},"CheckoutOptionsDeliveryEarliestResponseItem":{"properties":{"availableCarriers":{"description":"Available carriers for delivery","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier"},"type":"array"},"availableFacilityConnections":{"description":"Available facility connections","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection"},"type":"array"},"earliestPredictedDeliveryDate":{"description":"Earliest predicted delivery date","format":"date-time","type":"string"},"listingDetails":{"description":"Listing details","items":{"$ref":"#/components/schemas/CheckoutOptionsListingDetails"},"type":"array"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId"],"title":"CheckoutOptionsDeliveryEarliestResponseItem","type":"object","description":"CheckoutOptionsDeliveryEarliestResponseItem"},"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier":{"properties":{"carrierRef":{"description":"Carrier reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"name":{"description":"Carrier name","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["carrierRef","name"],"title":"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier","type":"object","description":"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier"},"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection":{"properties":{"connectionRef":{"description":"Connection reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["connectionRef"],"title":"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection","type":"object","description":"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection"},"CheckoutOptionsListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"description":"Custom attributes associated with the listing","type":"object"},"facilityRef":{"description":"Facility reference of the listing","type":"string"},"tenantFacilityId":{"description":"Tenant facility id of the listing","type":"string"}},"required":["facilityRef","tenantFacilityId"],"title":"CheckoutOptionsListingDetails","type":"object","description":"CheckoutOptionsListingDetails"}}}}
```

## The CheckoutOptionsDeliveryEarliestResponseItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryEarliestResponseItem":{"properties":{"availableCarriers":{"description":"Available carriers for delivery","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier"},"type":"array"},"availableFacilityConnections":{"description":"Available facility connections","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection"},"type":"array"},"earliestPredictedDeliveryDate":{"description":"Earliest predicted delivery date","format":"date-time","type":"string"},"listingDetails":{"description":"Listing details","items":{"$ref":"#/components/schemas/CheckoutOptionsListingDetails"},"type":"array"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId"],"title":"CheckoutOptionsDeliveryEarliestResponseItem","type":"object","description":"CheckoutOptionsDeliveryEarliestResponseItem"},"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier":{"properties":{"carrierRef":{"description":"Carrier reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"name":{"description":"Carrier name","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["carrierRef","name"],"title":"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier","type":"object","description":"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier"},"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection":{"properties":{"connectionRef":{"description":"Connection reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["connectionRef"],"title":"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection","type":"object","description":"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection"},"CheckoutOptionsListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"description":"Custom attributes associated with the listing","type":"object"},"facilityRef":{"description":"Facility reference of the listing","type":"string"},"tenantFacilityId":{"description":"Tenant facility id of the listing","type":"string"}},"required":["facilityRef","tenantFacilityId"],"title":"CheckoutOptionsListingDetails","type":"object","description":"CheckoutOptionsListingDetails"}}}}
```

## The CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier":{"properties":{"carrierRef":{"description":"Carrier reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"name":{"description":"Carrier name","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["carrierRef","name"],"title":"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier","type":"object","description":"CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier"}}}}
```

## The CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection":{"properties":{"connectionRef":{"description":"Connection reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["connectionRef"],"title":"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection","type":"object","description":"CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection"}}}}
```

## The CheckoutOptionsDeliveryTimePeriodRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryTimePeriodRequest":{"properties":{"basket":{"description":"Basket items","items":{"$ref":"#/components/schemas/BasketItem"},"type":"array"},"consumerAddress":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsConsumerAddress"}],"description":"Consumer delivery address"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"endDate":{"description":"End date-time of the period","format":"date-time","type":"string"},"includeCalculationHints":{"description":"Whether to include calculation hints in the response","type":"boolean"},"startDate":{"description":"Start date-time of the period","format":"date-time","type":"string"}},"required":["basket","consumerAddress"],"title":"CheckoutOptionsDeliveryTimePeriodRequest","type":"object","description":"CheckoutOptionsDeliveryTimePeriodRequest"},"BasketItem":{"properties":{"quantity":{"description":"Quantity","type":"integer"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","quantity"],"title":"BasketItem","type":"object","description":"BasketItem"},"CheckoutOptionsConsumerAddress":{"properties":{"addressType":{"description":"Type of address","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"city":{"description":"City name","type":"string"},"country":{"description":"Country code","type":"string"},"houseNumber":{"description":"House number","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street name","type":"string"}},"required":["country"],"title":"CheckoutOptionsConsumerAddress","type":"object","description":"CheckoutOptionsConsumerAddress"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"}}}}
```

## The CheckoutOptionsDeliveryTimePeriodResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryTimePeriodResponse":{"properties":{"calculationHints":{"description":"Calculation hints","items":{"type":"string"},"type":"array"},"checkoutOptions":{"description":"Checkout options across the requested period","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponseItem"},"type":"array"}},"required":["checkoutOptions"],"title":"CheckoutOptionsDeliveryTimePeriodResponse","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponse"},"CheckoutOptionsDeliveryTimePeriodResponseItem":{"properties":{"availableCarriers":{"description":"Available carriers for the date","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier"},"type":"array"},"availableFacilityConnections":{"description":"Available facility connections for the date","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection"},"type":"array"},"date":{"description":"Date of the option","format":"date-time","type":"string"},"overallStatus":{"description":"Overall availability status for the date","enum":["ALL","PARTIAL","NONE"],"type":"string"}},"required":["overallStatus","date"],"title":"CheckoutOptionsDeliveryTimePeriodResponseItem","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponseItem"},"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier":{"properties":{"carrierRef":{"description":"Carrier reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"name":{"description":"Carrier name","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["carrierRef","name"],"title":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier"},"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection":{"properties":{"connectionRef":{"description":"Connection reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["connectionRef"],"title":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection"}}}}
```

## The CheckoutOptionsDeliveryTimePeriodResponseItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryTimePeriodResponseItem":{"properties":{"availableCarriers":{"description":"Available carriers for the date","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier"},"type":"array"},"availableFacilityConnections":{"description":"Available facility connections for the date","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection"},"type":"array"},"date":{"description":"Date of the option","format":"date-time","type":"string"},"overallStatus":{"description":"Overall availability status for the date","enum":["ALL","PARTIAL","NONE"],"type":"string"}},"required":["overallStatus","date"],"title":"CheckoutOptionsDeliveryTimePeriodResponseItem","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponseItem"},"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier":{"properties":{"carrierRef":{"description":"Carrier reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"name":{"description":"Carrier name","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["carrierRef","name"],"title":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier"},"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection":{"properties":{"connectionRef":{"description":"Connection reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["connectionRef"],"title":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection"}}}}
```

## The CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier":{"properties":{"carrierRef":{"description":"Carrier reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"name":{"description":"Carrier name","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["carrierRef","name"],"title":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier"}}}}
```

## The CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection":{"properties":{"connectionRef":{"description":"Connection reference","type":"string"},"latestPickingStartDate":{"description":"Latest picking start date","format":"date-time","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days","items":{"type":"string"},"type":"array"}},"required":["connectionRef"],"title":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection","type":"object","description":"CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection"}}}}
```

## The CheckoutOptionsDeliveryTimePointRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryTimePointRequest":{"properties":{"desiredDeliveryDate":{"description":"Desired delivery date-time","format":"date-time","type":"string"},"facilities":{"description":"Facilities with latest picking start constraints","items":{"$ref":"#/components/schemas/FacilityRefLatestPickingStartPair"},"type":"array"},"tenantArticleIds":{"description":"Tenant article IDs","items":{"type":"string"},"type":"array"}},"required":["desiredDeliveryDate","tenantArticleIds","facilities"],"title":"CheckoutOptionsDeliveryTimePointRequest","type":"object","description":"CheckoutOptionsDeliveryTimePointRequest"},"FacilityRefLatestPickingStartPair":{"properties":{"facilityRef":{"description":"Facility reference","type":"string"},"latestPickingStart":{"description":"Latest picking start date-time","format":"date-time","type":"string"}},"required":["facilityRef","latestPickingStart"],"title":"FacilityRefLatestPickingStartPair","type":"object","description":"FacilityRefLatestPickingStartPair"}}}}
```

## The CheckoutOptionsDeliveryTimePointResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryTimePointResponse":{"properties":{"items":{"description":"Availability per article and facility","items":{"$ref":"#/components/schemas/CheckoutOptionsDeliveryTimePointResponseItem"},"type":"array"}},"required":["items"],"title":"CheckoutOptionsDeliveryTimePointResponse","type":"object","description":"CheckoutOptionsDeliveryTimePointResponse"},"CheckoutOptionsDeliveryTimePointResponseItem":{"properties":{"available":{"description":"Available quantity","type":"number"},"facilityRef":{"description":"Facility reference","type":"string"},"latestPickingStart":{"description":"Latest picking start date-time","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","available","facilityRef"],"title":"CheckoutOptionsDeliveryTimePointResponseItem","type":"object","description":"CheckoutOptionsDeliveryTimePointResponseItem"}}}}
```

## The CheckoutOptionsDeliveryTimePointResponseItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsDeliveryTimePointResponseItem":{"properties":{"available":{"description":"Available quantity","type":"number"},"facilityRef":{"description":"Facility reference","type":"string"},"latestPickingStart":{"description":"Latest picking start date-time","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","available","facilityRef"],"title":"CheckoutOptionsDeliveryTimePointResponseItem","type":"object","description":"CheckoutOptionsDeliveryTimePointResponseItem"}}}}
```

## The CheckoutOptionsFacilityFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsFacilityFilter":{"properties":{"customAttributes":{"description":"Custom attributes for facility filtering","type":"object"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"title":"CheckoutOptionsFacilityFilter","type":"object","description":"CheckoutOptionsFacilityFilter"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The CheckoutOptionsFacilityForCNC object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsFacilityForCNC":{"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"availabilities":{"description":"Article availabilities","items":{"$ref":"#/components/schemas/CheckoutOptionsAvailability"},"type":"array"},"closingDays":{"items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"customServices":{"description":"Custom services","items":{"$ref":"#/components/schemas/CheckoutOptionsCustomServices"},"type":"array"},"facilityRef":{"description":"Facility reference","type":"string"},"name":{"description":"Facility name","type":"string"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes"},"targetTime":{"description":"Target time for collection","format":"date-time","type":"string"}},"required":["facilityRef","name","address","closingDays","pickingTimes","availabilities","customServices","targetTime"],"title":"CheckoutOptionsFacilityForCNC","type":"object","description":"CheckoutOptionsFacilityForCNC"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CheckoutOptionsAvailability":{"properties":{"available":{"description":"Available quantity","type":"number"},"carrier":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsAvailabilityCarrier"}],"description":"Carrier details"},"isBackOrderable":{"description":"Is item back-orderable","type":"boolean"},"latestPickingStart":{"description":"Latest picking start","format":"date-time","type":"string"},"preOrderReleaseDate":{"description":"Pre-order release date","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","available","isBackOrderable"],"title":"CheckoutOptionsAvailability","type":"object","description":"CheckoutOptionsAvailability"},"CheckoutOptionsAvailabilityCarrier":{"properties":{"carrierProductCategory":{"description":"Carrier product category","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierRef":{"description":"Carrier reference","type":"string"}},"required":["carrierRef"],"title":"CheckoutOptionsAvailabilityCarrier","type":"object","description":"CheckoutOptionsAvailabilityCarrier"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"CheckoutOptionsCustomServices":{"properties":{"customServiceRef":{"description":"Custom service reference","type":"string"},"name":{"description":"Custom service name","type":"string"}},"required":["customServiceRef","name"],"title":"CheckoutOptionsCustomServices","type":"object","description":"CheckoutOptionsCustomServices"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"}}}}
```

## The CheckoutOptionsFacilityForSFS object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsFacilityForSFS":{"properties":{"availabilities":{"description":"Article availabilities","items":{"$ref":"#/components/schemas/CheckoutOptionsAvailability"},"type":"array"},"customServices":{"description":"Custom services","items":{"$ref":"#/components/schemas/CheckoutOptionsCustomServices"},"type":"array"},"deliveryOptions":{"items":{"$ref":"#/components/schemas/PromiseCarrier"},"type":"array"},"facilityRef":{"description":"Facility reference","type":"string"},"name":{"description":"Facility name","type":"string"}},"required":["facilityRef","name","availabilities","deliveryOptions","customServices"],"title":"CheckoutOptionsFacilityForSFS","type":"object","description":"CheckoutOptionsFacilityForSFS"},"CheckoutOptionsAvailability":{"properties":{"available":{"description":"Available quantity","type":"number"},"carrier":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsAvailabilityCarrier"}],"description":"Carrier details"},"isBackOrderable":{"description":"Is item back-orderable","type":"boolean"},"latestPickingStart":{"description":"Latest picking start","format":"date-time","type":"string"},"preOrderReleaseDate":{"description":"Pre-order release date","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","available","isBackOrderable"],"title":"CheckoutOptionsAvailability","type":"object","description":"CheckoutOptionsAvailability"},"CheckoutOptionsAvailabilityCarrier":{"properties":{"carrierProductCategory":{"description":"Carrier product category","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierRef":{"description":"Carrier reference","type":"string"}},"required":["carrierRef"],"title":"CheckoutOptionsAvailabilityCarrier","type":"object","description":"CheckoutOptionsAvailabilityCarrier"},"CheckoutOptionsCustomServices":{"properties":{"customServiceRef":{"description":"Custom service reference","type":"string"},"name":{"description":"Custom service name","type":"string"}},"required":["customServiceRef","name"],"title":"CheckoutOptionsCustomServices","type":"object","description":"CheckoutOptionsCustomServices"},"PromiseCarrier":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"},"carrierRef":{"type":"string"},"deliveryPromiseValidUntil":{"format":"date-time","type":"string"},"products":{"items":{"$ref":"#/components/schemas/PromiseDeliveryOptions"},"type":"array"}},"required":["carrierRef","carrierKey","carrierName","products"],"type":"object","xml":{"name":"PromiseCarrier"},"title":"PromiseCarrier","description":"PromiseCarrier"},"PromiseDeliveryOptions":{"additionalProperties":false,"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"deliveryCosts":{"items":{"$ref":"#/components/schemas/DeliveryCost"},"type":"array"},"estimatedDeliveryTime":{"$ref":"#/components/schemas/EstimatedDeliveryTime"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"}},"required":["carrierProductCategory","deliveryCosts"],"type":"object","xml":{"name":"PromiseDeliveryOptions"},"title":"PromiseDeliveryOptions","description":"PromiseDeliveryOptions"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"EstimatedDeliveryTime":{"properties":{"maxDeliveryDays":{"description":"Maximum total delivery time in days","minimum":0,"type":"integer"},"minDeliveryDays":{"description":"Minimum total delivery time in days","minimum":0,"type":"integer"}},"required":["maxDeliveryDays","minDeliveryDays"],"type":"object","title":"EstimatedDeliveryTime","description":"EstimatedDeliveryTime"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The CheckoutOptionsInput object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsInput":{"properties":{"consumerAddress":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsConsumerAddress"}],"description":"Consumer address"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes for filtering","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences","description":"Delivery preferences"},"filterDuplicates":{"description":"Filter duplicate facilities","type":"boolean"},"geoFence":{"$ref":"#/components/schemas/GeoFence","description":"Geofence restrictions"},"orderLineItems":{"description":"Order line items","items":{"type":"object"},"type":"array"},"tags":{"description":"Tags","items":{"type":"object"},"type":"array"}},"required":["deliveryPreferences","orderLineItems"],"title":"CheckoutOptionsInput","type":"object","description":"CheckoutOptionsInput"},"CheckoutOptionsConsumerAddress":{"properties":{"addressType":{"description":"Type of address","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"city":{"description":"City name","type":"string"},"country":{"description":"Country code","type":"string"},"houseNumber":{"description":"House number","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street name","type":"string"}},"required":["country"],"title":"CheckoutOptionsConsumerAddress","type":"object","description":"CheckoutOptionsConsumerAddress"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"GeoFence":{"description":"Center (described with lon and lat attributes) and a circular geofence (described as radius around the center)","properties":{"lat":{"description":"The latitude of the center, provided as decimal coordinate","type":"number"},"lon":{"description":"The longitude of the center, provided as decimal coordinate","type":"number"},"radius":{"description":"Radius around the center in kilometers (km, max. 100)","minimum":1,"type":"number"}},"required":["lat","lon","radius"],"type":"object","title":"GeoFence"}}}}
```

## The CheckoutOptionsListingDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CheckoutOptionsListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"description":"Custom attributes associated with the listing","type":"object"},"facilityRef":{"description":"Facility reference of the listing","type":"string"},"tenantFacilityId":{"description":"Tenant facility id of the listing","type":"string"}},"required":["facilityRef","tenantFacilityId"],"title":"CheckoutOptionsListingDetails","type":"object","description":"CheckoutOptionsListingDetails"}}}}
```

## The ClickAndCollectRerouteConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ClickAndCollectRerouteConfiguration":{"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RerouteType"}},"required":["active"],"type":"object","title":"ClickAndCollectRerouteConfiguration","description":"ClickAndCollectRerouteConfiguration"},"RerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The short picked line items will be moved to a new routing plan and rerouted","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RerouteType"}}}}
```

## The ClientNotificationChannel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"}}}}
```

## The ClientNotificationChannelForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ClientNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type"],"title":"ClientNotificationChannelForCreation","type":"object","description":"ClientNotificationChannelForCreation"}}}}
```

## The CloseStowJobAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CloseStowJobAction":{"description":"Sets the status of the stowjob to CLOSED","properties":{"name":{"description":"The name of the action that should be performed","enum":["CLOSE_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"CloseStowJobAction","type":"object"}}}}
```

## The ClosingDay object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"}}}}
```

## The CollectDelivery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"}}}}
```

## The CombinedCostRatingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CombinedCostRatingConfiguration":{"allOf":[{"$ref":"#/components/schemas/AbstractRatingConfiguration"}],"description":"This rating configuration is used to calculate the rating based on the total sales prices and/or the total shipping costs of the order line items. At least one of the cost components must be selected.","properties":{"totalSalesPrices":{"default":false,"description":">- If set to true, the total sales prices of the order line items are used for the calculation of the rating.","type":"boolean"},"totalShippingCosts":{"default":false,"description":"If set to true, the total shipping costs of the order line items are used for the calculation of the rating.\"","type":"boolean"},"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"CombinedCostRatingConfiguration"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"}}}}
```

## The CompanyAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CompanyAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"country":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"name":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["name","street","postalCode","city","country"],"type":"object","title":"CompanyAddress","description":"CompanyAddress"}}}}
```

## The ConditionWorkflowNode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConditionWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"allOf":[{"$ref":"#/components/schemas/WorkflowCondition"}],"description":"Condition expression that determines the path. Connections from this node must use .TRUE or .FALSE suffixes"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["CONDITION"],"type":"string"}},"required":["key","type","condition"],"title":"ConditionWorkflowNode","type":"object","description":"ConditionWorkflowNode"},"WorkflowNameLocaleString":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowNameLocaleString","type":"object"},"WorkflowDescriptionLocaleString":{"additionalProperties":{"maxLength":500,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowDescriptionLocaleString","type":"object"},"WorkflowCondition":{"properties":{"entity":{"description":"Entity type that the condition applies to","enum":["ORDER","INCOMING_EVENT","FACILITY"],"type":"string"},"expression":{"description":"Expression that defines the condition","type":"string"}},"required":["expression","entity"],"title":"WorkflowCondition","type":"object","description":"WorkflowCondition"}}}}
```

## The ConnectAppTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConnectAppTypeEnum":{"description":"The type of possible Apps","enum":["PICKING","INVENTORY","OPERATIONS_ANDROID","OPERATIONS_IOS","STORE_OPERATIONS_IOS","STORE_OPERATIONS_ANDROID"],"type":"string","title":"ConnectAppTypeEnum"}}}}
```

## The ConnectionRefusedAnalysis object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConnectionRefusedAnalysis":{"properties":{"containsInvalidContexts":{"description":"Indicates whether invalid contexts were found.","type":"boolean"},"containsInvalidTargets":{"description":"Indicates whether invalid targets were found.","type":"boolean"},"containsValidConnections":{"description":"Indicates whether valid connections exist.","type":"boolean"}},"required":["containsValidConnections","containsInvalidTargets","containsInvalidContexts"],"title":"ConnectionRefusedAnalysis","type":"object","description":"ConnectionRefusedAnalysis"}}}}
```

## The ConnectionsAnalysisResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConnectionsAnalysisResult":{"properties":{"canBeIntermediateHop":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of connections from the graph to the lookup facility (layer 1 or 2)."},"canSupplyIntermediateHop":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of lookup facility as potential layer 0 (supplier)."},"canSupplyTarget":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of connections from the lookup facility to the target."}},"required":["canSupplyIntermediateHop","canBeIntermediateHop","canSupplyTarget"],"title":"ConnectionsAnalysisResult","type":"object","description":"ConnectionsAnalysisResult"},"ConnectionRefusedAnalysis":{"properties":{"containsInvalidContexts":{"description":"Indicates whether invalid contexts were found.","type":"boolean"},"containsInvalidTargets":{"description":"Indicates whether invalid targets were found.","type":"boolean"},"containsValidConnections":{"description":"Indicates whether valid connections exist.","type":"boolean"}},"required":["containsValidConnections","containsInvalidTargets","containsInvalidContexts"],"title":"ConnectionRefusedAnalysis","type":"object","description":"ConnectionRefusedAnalysis"}}}}
```

## The ConnectionType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"}}}}
```

## The ConsolidatedRoutingPlanStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"}}}}
```

## The ConsumerAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"maxItems":500,"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"}}}}
```

## The ConsumerAddressesForSourcingOptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConsumerAddressesForSourcingOptions":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddressForSourcingOptions"},"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"type":"object","title":"ConsumerAddressesForSourcingOptions","description":"ConsumerAddressesForSourcingOptions"},"ConsumerAddressForSourcingOptions":{"additionalProperties":false,"properties":{"additionalAddressInfo":{"type":"string"},"addressType":{"$ref":"#/components/schemas/AddressType"},"city":{"description":"The city of the address.","type":"string"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"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"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/ConsumerAddressForSourcingOptionsPhoneNumber"},"type":"array"},"postalCode":{"description":"The postal code of the address.","type":"string"},"province":{"pattern":"^.+$","type":"string"},"salutation":{"type":"string"},"street":{"description":"The street of the address.","type":"string"}},"required":["country"],"title":"ConsumerAddressForSourcingOptions","description":"ConsumerAddressForSourcingOptions"},"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"},"ConsumerAddressForSourcingOptionsPhoneNumber":{"additionalProperties":false,"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","title":"ConsumerAddressForSourcingOptionsPhoneNumber","description":"ConsumerAddressForSourcingOptionsPhoneNumber"}}}}
```

## The ConsumerAddressForSourcingOptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConsumerAddressForSourcingOptions":{"additionalProperties":false,"properties":{"additionalAddressInfo":{"type":"string"},"addressType":{"$ref":"#/components/schemas/AddressType"},"city":{"description":"The city of the address.","type":"string"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"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"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/ConsumerAddressForSourcingOptionsPhoneNumber"},"type":"array"},"postalCode":{"description":"The postal code of the address.","type":"string"},"province":{"pattern":"^.+$","type":"string"},"salutation":{"type":"string"},"street":{"description":"The street of the address.","type":"string"}},"required":["country"],"title":"ConsumerAddressForSourcingOptions","description":"ConsumerAddressForSourcingOptions"},"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"},"ConsumerAddressForSourcingOptionsPhoneNumber":{"additionalProperties":false,"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","title":"ConsumerAddressForSourcingOptionsPhoneNumber","description":"ConsumerAddressForSourcingOptionsPhoneNumber"}}}}
```

## The ConsumerAddressForSourcingOptionsPhoneNumber object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConsumerAddressForSourcingOptionsPhoneNumber":{"additionalProperties":false,"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","title":"ConsumerAddressForSourcingOptionsPhoneNumber","description":"ConsumerAddressForSourcingOptionsPhoneNumber"}}}}
```

## The ConsumerAddressModifiedLogEntry object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"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"}}}}
```

## The ConsumerAddressModifiedLogPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ConsumerAddressModifiedLogPayload":{"properties":{"changes":{"description":"List of address changes","items":{"$ref":"#/components/schemas/ConsumerAddressModifiedLogEntry"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogPayload","description":"ConsumerAddressModifiedLogPayload"},"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"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"}}}}
```

## The ContainerDimensions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"}}}}
```

## The ContextLimitation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The ContextOperator object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"}}}}
```

## The ContextReference object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ContextReference":{"properties":{"reference":{"type":"string"},"routingDecisionContext":{"$ref":"#/components/schemas/RoutingDecisionContext"}},"required":["reference","routingDecisionContext"],"title":"ContextReference","description":"ContextReference"},"RoutingDecisionContext":{"enum":["LISTING","CARRIER"],"title":"RoutingDecisionContext","description":"RoutingDecisionContext"}}}}
```

## The Coordinates object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The CostCoefficientCostDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"}}}}
```

## The CostCoefficientMeasurementUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"}}}}
```

## The CostMeasurementUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"}}}}
```

## The CountryCode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CountryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string","title":"CountryCode"}}}}
```

## The CountryLanguageMapping object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CountryLanguageMapping":{"additionalProperties":{"type":"string"},"type":"object","title":"CountryLanguageMapping","description":"CountryLanguageMapping"}}}}
```

## The CurrencyCode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The CustomAttributableVersionedResource object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomAttributableVersionedResource":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"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"],"title":"CustomAttributableVersionedResource","type":"object","description":"CustomAttributableVersionedResource"}}}}
```

## The CustomAttributesResource object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"}}}}
```

## The CustomClaims object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The CustomPrioritizationRule object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomPrioritizationRule":{"allOf":[{"$ref":"#/components/schemas/PrioritizationRule"}],"description":"You can supply a CUSTOM Prioritization rule. In order to successfully supply such a rule you also need to provide an evaluatable Expression in vmExpression. This expression needs to return an integer value that adds additional priority to an order.","properties":{"vmExpression":{"type":"string"}},"required":["vmExpression"],"type":"object","xml":{"name":"CustomPrioritizationRule"},"title":"CustomPrioritizationRule"},"PrioritizationRule":{"description":"You can select a default Prioritization Rule from the catalog. When you decide to select 'CUSTOM' you must also provide a vmExpression to match the type CustomPrioritizationRule.","properties":{"active":{"type":"boolean"},"id":{"description":"This value identifies this very instance of the prioritization rule. It is set autmatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/PrioritizationRuleImplementation"},"name":{"type":"string"}},"required":["active","name","implementation"],"type":"object","title":"PrioritizationRule"},"PrioritizationRuleImplementation":{"enum":["CUSTOM"],"type":"string","xml":{"name":"PrioritizationRuleImplementation"},"title":"PrioritizationRuleImplementation","description":"PrioritizationRuleImplementation"}}}}
```

## The CustomService object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomService":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information entries defined for this custom service","items":{"$ref":"#/components/schemas/AdditionalInformation"},"maxItems":15,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to custom service. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"description":{"description":"Translated description derived from descriptionLocalized based on the requested locale","minLength":1,"type":"string"},"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"id":{"description":"Unique ID of this custom service","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images for this custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing a service job of this custom service","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items of the custom service are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"Translated name derived from nameLocalized based on the requested locale","minLength":1,"type":"string"},"status":{"description":"Deprecated values: ENABLED and DISABLED, use INACTIVE and ACTIVE instead","enum":["ENABLED","DISABLED","INACTIVE","ACTIVE"],"type":"string"},"tenantCustomServiceId":{"description":"Tenant specific ID of the custom service","minLength":1,"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["status","nameLocalized","itemsRequired","id","created","lastModified","version"],"title":"CustomService","type":"object","description":"CustomService"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description derived from descriptionLocalized based on the requested locale","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name derived from nameLocalized based on the requested locale","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"Id to identifiy the additional information on an external system. Must be unique per CustomService.","minLength":1,"type":"string"},"valueType":{"description":"Type of the value","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"AdditionalInformation","type":"object","description":"AdditionalInformation"}}}}
```

## The CustomServiceDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"}}}}
```

## The CustomServiceForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomServiceForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information fields to be collected when executing this custom service","items":{"$ref":"#/components/schemas/AdditionalInformationForCreation"},"maxItems":15,"type":"array"},"customAttributes":{"description":"Attributes that can be added to custom service. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"imageRefs":{"description":"List of linked images for this custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing a service job of this custom service","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items of the custom service are returnable after execution","type":"boolean"},"status":{"description":"Deprecated values: ENABLED and DISABLED, use INACTIVE and ACTIVE instead","enum":["ENABLED","DISABLED","INACTIVE","ACTIVE"],"type":"string"},"tenantCustomServiceId":{"description":"Tenant specific ID of the custom service","minLength":1,"type":"string"}},"required":["status","nameLocalized","itemsRequired"],"title":"CustomServiceForCreation","type":"object","description":"CustomServiceForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalInformationForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"tenantAdditionalInformationId":{"description":"Id to identifiy the additional information on an external system. Must be unique per CustomService.","minLength":1,"type":"string"},"valueType":{"description":"Type of the value","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType"],"title":"AdditionalInformationForCreation","type":"object","description":"AdditionalInformationForCreation"}}}}
```

## The CustomServiceForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomServiceForUpdate":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the custom service. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"itemsRequired":{"description":"Indicates whether items are required for executing a service job of this custom service","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items of the custom service are returnable after the custom service has been executed","type":"boolean"},"status":{"description":"Deprecated values: ENABLED and DISABLED, use INACTIVE and ACTIVE instead","enum":["ENABLED","DISABLED","INACTIVE","ACTIVE"],"type":"string"},"tenantCustomServiceId":{"description":"Tenant specific ID of the custom service","minLength":1,"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","minimum":1,"type":"integer"}},"required":["version"],"title":"CustomServiceForUpdate","type":"object","description":"CustomServiceForUpdate"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The CustomServiceItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"}}}}
```

## The CustomServiceItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"}}}}
```

## The CustomServicePatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomServicePatchActions":{"properties":{"actions":{"description":"List of actions to apply to this custom service","items":{"anyOf":[{"$ref":"#/components/schemas/ModifyCustomServiceAction"}]},"maxItems":10,"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["actions","version"],"title":"CustomServicePatchActions","type":"object","description":"CustomServicePatchActions"},"ModifyCustomServiceAction":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyCustomService', because you want to modify a custom service","enum":["ModifyCustomService"],"type":"string"},"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"imageRefs":{"description":"List of linked images for this custom service","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing a service job of this custom service","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items of the custom service are returnable after the custom service has been executed","type":"boolean"},"status":{"description":"New status to set for the custom service","enum":["ENABLED","DISABLED","INACTIVE","ACTIVE"],"type":"string"},"tenantCustomServiceId":{"description":"Tenant specific ID of the custom service to be modified","minLength":1,"type":"string"}},"required":["action"],"title":"ModifyCustomServiceAction","type":"object","description":"ModifyCustomServiceAction"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The CustomServiceReference object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"}}}}
```

## The CustomServiceReferenceForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"}}}}
```

## The CutoffTime object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CutoffTime":{"nullable":true,"properties":{"hour":{"default":12,"type":"number"},"minute":{"default":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"CutoffTime","description":"CutoffTime"}}}}
```

## The CutoffTimeConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"CutoffTimeConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"clickAndCollect":{"$ref":"#/components/schemas/CutoffTime"},"id":{"type":"string"},"shipFromStore":{"$ref":"#/components/schemas/CutoffTime"}},"required":["shipFromStore","clickAndCollect"],"type":"object","title":"CutoffTimeConfiguration","description":"CutoffTimeConfiguration"},"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"},"CutoffTime":{"nullable":true,"properties":{"hour":{"default":12,"type":"number"},"minute":{"default":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"CutoffTime","description":"CutoffTime"}}}}
```

## The DateEqFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DateEqFilter":{"properties":{"eq":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateEqFilter","type":"object","description":"DateEqFilter"}}}}
```

## The DateFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The DateListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DateListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/DateEqFilter"}},"title":"DateListFilter","type":"object","description":"DateListFilter"},"DateEqFilter":{"properties":{"eq":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateEqFilter","type":"object","description":"DateEqFilter"}}}}
```

## The DecisionLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DecisionLog":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityDecisions":{"items":{"$ref":"#/components/schemas/FacilityDecision"},"type":"array"},"id":{"type":"string"},"latestPickingStartHints":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />In case no LPS could be calculated for this facility, the possible causes will be listed in this array. This property is an alpha property and still under development","type":"object"},"orderSplitDecision":{"$ref":"#/components/schemas/OrderSplitDecision"},"results":{"$ref":"#/components/schemas/RoutingResults"},"routingPlanRef":{"type":"string"},"routingRun":{"type":"number"},"routingStrategyEvaluationResult":{"$ref":"#/components/schemas/RoutingStrategyEvaluationResult"},"statistics":{"$ref":"#/components/schemas/RoutingStatistics"}},"required":["id","routingPlanRef","facilityDecisions","routingRun","statistics","results","created","lastModified","version"],"type":"object","xml":{"name":"DecisionLog"},"title":"DecisionLog","description":"DecisionLog"},"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"},"FacilityDecision":{"properties":{"availabilities":{"items":{"$ref":"#/components/schemas/AvailabilityDuringRouting"},"type":"array"},"facility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"isBestAvailable":{"type":"boolean"},"isBestRated":{"type":"boolean"},"isBestReassignmentCandidate":{"type":"boolean"},"latestPickingStartInformation":{"$ref":"#/components/schemas/LatestPickingStartForDecisionLog"},"orderFences":{"items":{"$ref":"#/components/schemas/OrderFenceDecision"},"type":"array"},"orderLineItemFences":{"items":{"$ref":"#/components/schemas/OrderLineItemFenceDecisions"},"type":"array"},"orderRatings":{"items":{"$ref":"#/components/schemas/OrderRatingDecision"},"type":"array"},"rank":{"type":"number"},"totalPenalty":{"type":"number"}},"required":["facility","orderFences","orderLineItemFences","orderRatings","orderLineItemRatings","availabilities"],"title":"FacilityDecision","description":"FacilityDecision"},"AvailabilityDuringRouting":{"properties":{"articleTitle":{"type":"string"},"available":{"type":"number"},"availablePostRerouteAdjustment":{"type":"number"},"bundleInformation":{"items":{"$ref":"#/components/schemas/BundleInformation"},"type":"array"},"isBackOrderable":{"default":false,"type":"boolean"},"preOrderDate":{"format":"date-time","type":"string"},"requestedQuantity":{"type":"number"},"rerouteInformation":{"$ref":"#/components/schemas/AvailabilityDuringRerouteStock"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","requestedQuantity","available","isBackOrderable"],"title":"AvailabilityDuringRouting","description":"AvailabilityDuringRouting"},"BundleInformation":{"properties":{"customServiceNodeId":{"type":"string"},"requestedQuantity":{"type":"number"}},"required":["customServiceNodeId","requestedQuantity"],"title":"BundleInformation","description":"BundleInformation"},"AvailabilityDuringRerouteStock":{"properties":{"pickedQuantity":{"type":"number"},"rerouteReason":{"$ref":"#/components/schemas/RerouteReason"}},"title":"AvailabilityDuringRerouteStock","description":"AvailabilityDuringRerouteStock"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"DecisionLogFacilityInfo":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"required":["name","facilityRef"],"title":"DecisionLogFacilityInfo","description":"DecisionLogFacilityInfo"},"LatestPickingStartForDecisionLog":{"properties":{"carrierRef":{"type":"string"},"latestPickingStartDate":{"format":"date-time","type":"string"},"lpsCalculationHints":{"description":"@deprecated, use hints","items":{"type":"string"},"type":"array"},"targetTime":{"format":"date-time","type":"string"}},"type":"object","title":"LatestPickingStartForDecisionLog","description":"LatestPickingStartForDecisionLog"},"OrderFenceDecision":{"properties":{"decision":{"$ref":"#/components/schemas/FenceResultStatus"},"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/OrderFenceDecisionDetail"},{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"name":{"type":"string"}},"required":["name","decision","details"],"type":"object","title":"OrderFenceDecision","description":"OrderFenceDecision"},"FenceResultStatus":{"enum":["FAILED","PASSED","REACTIVE_PASSING_POSSIBLE"],"title":"FenceResultStatus","description":"FenceResultStatus"},"OrderFenceDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Order Fence Decision Detail.","properties":{"actualValue":{"type":"string"},"contextReference":{"$ref":"#/components/schemas/ContextReference"},"expectedValue":{"type":"string"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"}},"required":["expectedValue","decisionType"],"title":"OrderFenceDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ContextReference":{"properties":{"reference":{"type":"string"},"routingDecisionContext":{"$ref":"#/components/schemas/RoutingDecisionContext"}},"required":["reference","routingDecisionContext"],"title":"ContextReference","description":"ContextReference"},"RoutingDecisionContext":{"enum":["LISTING","CARRIER"],"title":"RoutingDecisionContext","description":"RoutingDecisionContext"},"ReactiveErrorReason":{"enum":["BACKORDER_LISTING","PREORDER_LISTING"],"title":"ReactiveErrorReason","description":"ReactiveErrorReason"},"ToolkitDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Decision Detail.","properties":{"comparisonOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleOperatorResultExplanation"},"leftPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"leftSideEvaluation":{"type":"boolean"},"rightPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"rightSideEvaluation":{"type":"boolean"}},"required":["decisionType","leftSideEvaluation","description"],"title":"ToolkitDecisionDetail"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitRuleOperatorResultExplanation":{"enum":["SKIPPED","BOTH_CONDITIONS_MET","ONLY_FIRST_CONDITION_MET","ONLY_SECOND_CONDITION_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleOperatorResultExplanation","description":"ToolkitRuleOperatorResultExplanation"},"ToolkitPredicatesDecisionDetail":{"properties":{"connector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicateDecisionDetail"},"type":"array"}},"required":["connector","predicates"],"title":"ToolkitPredicatesDecisionDetail","description":"ToolkitPredicatesDecisionDetail"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitComparisonDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Comparison Decision Detail.","properties":{"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolKitComparisonDetails"},"type":"array"}},"required":["predicates","predicateConnector","description"],"title":"ToolkitComparisonDecisionDetail"},"ToolkitRuleComparePropertiesOperatorResultExplanation":{"enum":["ALL_PREDICATES_MET","NOT_ALL_PREDICATES_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleComparePropertiesOperatorResultExplanation","description":"ToolkitRuleComparePropertiesOperatorResultExplanation"},"ToolKitComparisonDetails":{"properties":{"evaluationResult":{"type":"boolean"},"leftPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"},"predicate":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"rightPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"}},"required":["leftPart","rightPart","evaluationResult","predicate"],"title":"ToolKitComparisonDetails","description":"ToolKitComparisonDetails"},"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"OrderLineItemFenceDecisions":{"properties":{"name":{"type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemFenceDecision"},"type":"array"}},"required":["name","orderLineItems"],"title":"OrderLineItemFenceDecisions","description":"OrderLineItemFenceDecisions"},"OrderLineItemFenceDecision":{"properties":{"articleTitle":{"type":"string"},"decision":{"$ref":"#/components/schemas/FenceResultStatus"},"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/OrderFenceDecisionDetail"},{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","articleTitle","decision","details"],"type":"object","title":"OrderLineItemFenceDecision","description":"OrderLineItemFenceDecision"},"OrderRatingDecision":{"properties":{"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"maxPenalty":{"type":"number"},"name":{"type":"string"},"normalizedScore":{"type":"number"},"score":{"type":"number"}},"required":["name","normalizedScore","maxPenalty"],"type":"object","title":"OrderRatingDecision","description":"OrderRatingDecision"},"OrderSplitDecision":{"properties":{"reassignment":{"$ref":"#/components/schemas/ReassignmentInformation"},"split":{"$ref":"#/components/schemas/SplitInformation"},"splitType":{"$ref":"#/components/schemas/SplitResultType"}},"required":["splitType"],"title":"OrderSplitDecision","description":"OrderSplitDecision"},"ReassignmentInformation":{"properties":{"reassignedItems":{"items":{"$ref":"#/components/schemas/AssignmentItem"},"type":"array"},"sourceFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"}},"required":["sourceFacility","reassignedItems"],"title":"ReassignmentInformation","description":"ReassignmentInformation"},"AssignmentItem":{"properties":{"articleTitle":{"type":"string"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"AssignmentItem","description":"AssignmentItem"},"SplitInformation":{"properties":{"splitCount":{"type":"number"},"splittedItems":{"items":{"$ref":"#/components/schemas/AssignmentItem"},"type":"array"},"targetFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"targetRoutingPlanRef":{"type":"string"}},"required":["splitCount","targetRoutingPlanRef","splittedItems"],"title":"SplitInformation","description":"SplitInformation"},"SplitResultType":{"enum":["SPLIT","DO_NOT_SPLIT","DO_NOT_SPLIT_USE_BEST_RATED","DO_NOT_SPLIT_BECAUSE_AVAILABILITY_USE_BEST_RATED","DO_NOT_SPLIT_USE_BEST_AVAILABLE","REASSIGN_TO_PARENT","REASSIGN_TO_PARENT_COMPLETELY","FAIL","INVALID_SPLIT","PARK_IN_WAITING_ROOM"],"title":"SplitResultType","description":"SplitResultType"},"RoutingResults":{"properties":{"assignedItems":{"items":{"$ref":"#/components/schemas/AssignmentItem"},"type":"array"},"bestAvailableFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"bestRatedFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"bestReassignmentFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"routingPlanStatus":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["assignedItems"],"title":"RoutingResults","description":"RoutingResults"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"RoutingStrategyEvaluationResult":{"properties":{"evaluatedConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"evaluatedPath":{"items":{"$ref":"#/components/schemas/RoutingStrategyPathElement"},"type":"array"}},"required":["evaluatedConfig","evaluatedPath"],"type":"object","title":"RoutingStrategyEvaluationResult","description":"RoutingStrategyEvaluationResult"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyPathElement":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"evaluationResult":{"$ref":"#/components/schemas/RoutingStrategyEvaluationResultType"},"ref":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyPathElementType"}},"required":["type","ref","evaluationResult","nameLocalized"],"type":"object","title":"RoutingStrategyPathElement","description":"RoutingStrategyPathElement"},"RoutingStrategyEvaluationResultType":{"enum":["NODE_INACTIVE","NODE_ACTIVE","CONDITION_INACTIVE","CONDITION_FALSE","CONDITION_TRUE"],"type":"string","title":"RoutingStrategyEvaluationResultType","description":"RoutingStrategyEvaluationResultType"},"RoutingStrategyPathElementType":{"enum":["CONDITION","NODE"],"type":"string","title":"RoutingStrategyPathElementType","description":"RoutingStrategyPathElementType"},"RoutingStatistics":{"properties":{"durationMs":{"type":"number"},"fenceStatistics":{"items":{"$ref":"#/components/schemas/FenceStatistic"},"type":"array"},"ratingStatistics":{"items":{"$ref":"#/components/schemas/RatingStatistic"},"type":"array"}},"required":["fenceStatistics","ratingStatistics","lineItemFenceStatistics"],"title":"RoutingStatistics","description":"RoutingStatistics"},"FenceStatistic":{"properties":{"durationMs":{"description":"Duration in Milliseconds","type":"number"},"name":{"type":"string"},"passedAmount":{"type":"number"},"passedPercentage":{"type":"number"},"rejectedAmount":{"type":"number"}},"required":["name","rejectedAmount","passedAmount","passedPercentage","durationMs"],"title":"FenceStatistic","description":"FenceStatistic"},"RatingStatistic":{"properties":{"durationMs":{"description":"Duration in Milliseconds","type":"number"},"maxPenalty":{"type":"number"},"maxScore":{"type":"number"},"minScore":{"type":"number"},"name":{"type":"string"}},"required":["name","maxPenalty","durationMs"],"title":"RatingStatistic","description":"RatingStatistic"}}}}
```

## The DecisionLogFacilityInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DecisionLogFacilityInfo":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"required":["name","facilityRef"],"title":"DecisionLogFacilityInfo","description":"DecisionLogFacilityInfo"}}}}
```

## The DecisionLogRef object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"}}}}
```

## The DecisionReasonContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DecisionReasonContext":{"properties":{"type":{"enum":["ITEM_RETURN_LINE_ITEM_STATUS"],"type":"string"},"values":{"items":{"enum":["ACCEPTED","REJECTED","WAITING_FOR_INPUT"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"title":"DecisionReasonContext","type":"object","description":"DecisionReasonContext"}}}}
```

## The DecisionType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"}}}}
```

## The DefaultPickingTimesConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DefaultPickingTimesConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"The default picking times are Mo-Sa 09:00-17:00"}},"required":["pickingTimes"],"type":"object","title":"DefaultPickingTimesConfiguration","description":"DefaultPickingTimesConfiguration"},"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"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"}}}}
```

## The DeleteRefuseReasonParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeleteRefuseReasonParameter":{"additionalProperties":false,"properties":{"handoverConfigurationVersion":{"type":"number"}},"required":["handoverConfigurationVersion"],"type":"object","title":"DeleteRefuseReasonParameter","description":"DeleteRefuseReasonParameter"}}}}
```

## The DeliverCostCoefficient object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"}}}}
```

## The DeliveryAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"companyName":{"pattern":"^.+$","type":"string"},"firstName":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"lastName":{"pattern":"^.+$","type":"string"},"personalTitle":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","postalCode","city"],"type":"object","title":"DeliveryAddress","description":"DeliveryAddress"}}}}
```

## The DeliveryAddressWithType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryAddressWithType":{"allOf":[{"$ref":"#/components/schemas/DeliveryAddress"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"}},"required":["street","houseNumber","postalCode","city","addressType"],"type":"object","title":"DeliveryAddressWithType","description":"DeliveryAddressWithType"},"DeliveryAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"companyName":{"pattern":"^.+$","type":"string"},"firstName":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"lastName":{"pattern":"^.+$","type":"string"},"personalTitle":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","postalCode","city"],"type":"object","title":"DeliveryAddress","description":"DeliveryAddress"},"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"}}}}
```

## The DeliveryArea object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryArea":{"properties":{"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"}},"required":["country","postalCode"],"type":"object","title":"DeliveryArea","description":"DeliveryArea"}}}}
```

## The DeliveryCost object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"}}}}
```

## The DeliveryEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"}}}}
```

## The DeliveryEventTargetAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"}}}}
```

## The DeliveryNote object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryNote":{"properties":{"companyAddress":{"$ref":"#/components/schemas/CompanyAddress"},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress","description":"use this if no deliveryAddresses are passed."},"deliveryAddresses":{"description":"if this field is filled, the delivery address will be taken from here according to this sorting: PARCEL_LOCKER > POSTAL_ADDRESS > INVOICE_ADDRESS. Each type is only allowed once.","items":{"$ref":"#/components/schemas/DeliveryAddressWithType"},"type":"array"},"items":{"items":{"$ref":"#/components/schemas/DeliveryNoteItem"},"type":"array"},"orderInformation":{"$ref":"#/components/schemas/OrderInformation"}},"required":["orderInformation","items"],"type":"object","title":"DeliveryNote","description":"DeliveryNote"},"CompanyAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"country":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"name":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["name","street","postalCode","city","country"],"type":"object","title":"CompanyAddress","description":"CompanyAddress"},"DeliveryAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"companyName":{"pattern":"^.+$","type":"string"},"firstName":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"lastName":{"pattern":"^.+$","type":"string"},"personalTitle":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","postalCode","city"],"type":"object","title":"DeliveryAddress","description":"DeliveryAddress"},"DeliveryAddressWithType":{"allOf":[{"$ref":"#/components/schemas/DeliveryAddress"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"}},"required":["street","houseNumber","postalCode","city","addressType"],"type":"object","title":"DeliveryAddressWithType","description":"DeliveryAddressWithType"},"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"},"DeliveryNoteItem":{"properties":{"id":{"type":"string"},"quantity":{"type":"string"},"substitutes":{"description":"Titel of the item which is substituted through this item","type":"string"},"title":{"type":"string"}},"required":["id","title","quantity"],"type":"object","title":"DeliveryNoteItem","description":"DeliveryNoteItem"},"OrderInformation":{"properties":{"orderDate":{"description":"The date the order was created.","format":"date-time","type":"string"},"orderNumber":{"description":"An identifier for the order.","pattern":"^.+$","type":"string"}},"type":"object","title":"OrderInformation","description":"OrderInformation"}}}}
```

## The DeliveryNoteConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryNoteConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"articleIdLabel":{"$ref":"#/components/schemas/LocaleString"},"articleTitleLabel":{"$ref":"#/components/schemas/LocaleString"},"companyAddress":{"$ref":"#/components/schemas/CompanyAddress"},"description":{"$ref":"#/components/schemas/LocaleString"},"disclaimer":{"$ref":"#/components/schemas/LocaleString"},"headline":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"logoUrl":{"type":"string"},"orderDateLabel":{"$ref":"#/components/schemas/LocaleString"},"orderNumberLabel":{"$ref":"#/components/schemas/LocaleString"},"pageLabel":{"$ref":"#/components/schemas/LocaleString"},"pdfBackgroundConfiguration":{"$ref":"#/components/schemas/PdfBackgroundConfiguration"},"quantityLabel":{"$ref":"#/components/schemas/LocaleString"},"substituteText":{"$ref":"#/components/schemas/LocaleString"}},"required":["id","orderNumberLabel","orderDateLabel","headline","quantityLabel","articleIdLabel","articleTitleLabel","pageLabel"],"type":"object","title":"DeliveryNoteConfiguration","description":"DeliveryNoteConfiguration"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"CompanyAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"country":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"name":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["name","street","postalCode","city","country"],"type":"object","title":"CompanyAddress","description":"CompanyAddress"},"PdfBackgroundConfiguration":{"properties":{"firstPageBackgroundFileUrl":{"description":"File url of the background image that will be used for the first page","type":"string"},"followingPageBackgroundFileUrl":{"description":"File url of background image that will be used for 2-n pages","type":"string"}},"type":"object","title":"PdfBackgroundConfiguration","description":"PdfBackgroundConfiguration"}}}}
```

## The DeliveryNoteConfigurationForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryNoteConfigurationForUpsert":{"properties":{"articleIdLabel":{"$ref":"#/components/schemas/LocaleString"},"articleTitleLabel":{"$ref":"#/components/schemas/LocaleString"},"companyAddress":{"$ref":"#/components/schemas/CompanyAddress"},"description":{"$ref":"#/components/schemas/LocaleString"},"disclaimer":{"$ref":"#/components/schemas/LocaleString"},"headline":{"$ref":"#/components/schemas/LocaleString"},"logo":{"$ref":"#/components/schemas/NamedFile"},"orderDateLabel":{"$ref":"#/components/schemas/LocaleString"},"orderNumberLabel":{"$ref":"#/components/schemas/LocaleString"},"pageLabel":{"$ref":"#/components/schemas/LocaleString"},"pdfBackgroundConfiguration":{"$ref":"#/components/schemas/PdfBackgroundConfigurationForUpsert"},"quantityLabel":{"$ref":"#/components/schemas/LocaleString"},"substituteText":{"$ref":"#/components/schemas/LocaleString"},"version":{"description":"Version field is used in the optimistic locking process. If the configuration doesn't exists, this field is ignored.","type":"number"}},"required":["version","orderNumberLabel","orderDateLabel","headline","quantityLabel","articleIdLabel","articleTitleLabel","pageLabel"],"type":"object","title":"DeliveryNoteConfigurationForUpsert","description":"DeliveryNoteConfigurationForUpsert"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"CompanyAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"country":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"name":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["name","street","postalCode","city","country"],"type":"object","title":"CompanyAddress","description":"CompanyAddress"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"PdfBackgroundConfigurationForUpsert":{"properties":{"firstPageBackgroundFile":{"$ref":"#/components/schemas/NamedFile"},"followingPageBackgroundFile":{"$ref":"#/components/schemas/NamedFile"}},"type":"object","title":"PdfBackgroundConfigurationForUpsert","description":"PdfBackgroundConfigurationForUpsert"}}}}
```

## The DeliveryNoteItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryNoteItem":{"properties":{"id":{"type":"string"},"quantity":{"type":"string"},"substitutes":{"description":"Titel of the item which is substituted through this item","type":"string"},"title":{"type":"string"}},"required":["id","title","quantity"],"type":"object","title":"DeliveryNoteItem","description":"DeliveryNoteItem"}}}}
```

## The DeliveryPreferences object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"}}}}
```

## The DeliveryPreferencesShipping object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"}}}}
```

## The DeliveryPromiseCollect object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryPromiseCollect":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BasicDeliveryPromiseShipment"}],"properties":{"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","xml":{"name":"DeliveryPromiseCollect"},"title":"DeliveryPromiseCollect","description":"DeliveryPromiseCollect"},"BasicDeliveryPromiseShipment":{"additionalProperties":false,"properties":{"facility":{"$ref":"#/components/schemas/BasicDeliveryPromiseShipmentFacility"},"lineItems":{"items":{"$ref":"#/components/schemas/DeliveryPromiseLineItem"},"type":"array"}},"required":["lineItems","facility"],"type":"object","xml":{"name":"DeliveryPromiseShipment"},"title":"BasicDeliveryPromiseShipment","description":"BasicDeliveryPromiseShipment"},"BasicDeliveryPromiseShipmentFacility":{"additionalProperties":false,"properties":{"facilityName":{"type":"string"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityName","facilityRef"],"title":"BasicDeliveryPromiseShipmentFacility","description":"BasicDeliveryPromiseShipmentFacility"},"DeliveryPromiseLineItem":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DeliveryPromiseLineItem","description":"DeliveryPromiseLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"}}}}
```

## The DeliveryPromiseLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryPromiseLineItem":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DeliveryPromiseLineItem","description":"DeliveryPromiseLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"}}}}
```

## The DeliveryPromiseShipment object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryPromiseShipment":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BasicDeliveryPromiseShipment"}],"properties":{"carriers":{"items":{"$ref":"#/components/schemas/PromiseCarrier"},"type":"array"}},"required":["carriers"],"type":"object","xml":{"name":"DeliveryPromiseShipment"},"title":"DeliveryPromiseShipment","description":"DeliveryPromiseShipment"},"BasicDeliveryPromiseShipment":{"additionalProperties":false,"properties":{"facility":{"$ref":"#/components/schemas/BasicDeliveryPromiseShipmentFacility"},"lineItems":{"items":{"$ref":"#/components/schemas/DeliveryPromiseLineItem"},"type":"array"}},"required":["lineItems","facility"],"type":"object","xml":{"name":"DeliveryPromiseShipment"},"title":"BasicDeliveryPromiseShipment","description":"BasicDeliveryPromiseShipment"},"BasicDeliveryPromiseShipmentFacility":{"additionalProperties":false,"properties":{"facilityName":{"type":"string"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityName","facilityRef"],"title":"BasicDeliveryPromiseShipmentFacility","description":"BasicDeliveryPromiseShipmentFacility"},"DeliveryPromiseLineItem":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DeliveryPromiseLineItem","description":"DeliveryPromiseLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"PromiseCarrier":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"},"carrierRef":{"type":"string"},"deliveryPromiseValidUntil":{"format":"date-time","type":"string"},"products":{"items":{"$ref":"#/components/schemas/PromiseDeliveryOptions"},"type":"array"}},"required":["carrierRef","carrierKey","carrierName","products"],"type":"object","xml":{"name":"PromiseCarrier"},"title":"PromiseCarrier","description":"PromiseCarrier"},"PromiseDeliveryOptions":{"additionalProperties":false,"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"deliveryCosts":{"items":{"$ref":"#/components/schemas/DeliveryCost"},"type":"array"},"estimatedDeliveryTime":{"$ref":"#/components/schemas/EstimatedDeliveryTime"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"}},"required":["carrierProductCategory","deliveryCosts"],"type":"object","xml":{"name":"PromiseDeliveryOptions"},"title":"PromiseDeliveryOptions","description":"PromiseDeliveryOptions"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"EstimatedDeliveryTime":{"properties":{"maxDeliveryDays":{"description":"Maximum total delivery time in days","minimum":0,"type":"integer"},"minDeliveryDays":{"description":"Minimum total delivery time in days","minimum":0,"type":"integer"}},"required":["maxDeliveryDays","minDeliveryDays"],"type":"object","title":"EstimatedDeliveryTime","description":"EstimatedDeliveryTime"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The DeliveryReservationMode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"}}}}
```

## The DeliveryReservationPreferences object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"}}}}
```

## The DeliveryTarget object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"}}}}
```

## The DhlTrackingLocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"}}}}
```

## The DhlTrackingStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"}}}}
```

## The DhlV2CarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DhlV2CarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"alwaysDoTrackAndTrace":{"description":"Whether to always perform track and trace","type":"boolean"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"sftpConfiguration":{"allOf":[{"$ref":"#/components/schemas/SftpConfiguration"}],"description":"SFTP configuration for track and trace"},"shipperRef":{"description":"Shipper reference","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"DhlV2CarrierConfiguration","type":"object","description":"DhlV2CarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"SftpConfiguration":{"properties":{"useSftpForTandT":{"description":"Indicates if the carrier uses sftp for getting track and trace data","type":"boolean"}},"required":["useSftpForTandT"],"title":"SftpConfiguration","type":"object","description":"SftpConfiguration"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The DiagnosticCode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DiagnosticCode":{"description":"Indicates the specific reason a picking diagnostic was raised.\n\nSTOCK_SHORT_PICK => The quantity picked from a partial stock location was below the requested quantity, while short-pick handling was enabled for this configuration.\n\nLINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was below the requested quantity.\n\nSTOCK_NOT_FOUND => The specified stock reference or tenant stock ID could not be found.\n\nINSUFFICIENT_STOCK => The target stock did not have enough available quantity to fulfill the request.","enum":["STOCK_SHORT_PICK","LINE_ITEM_SHORT_PICK","STOCK_NOT_FOUND","INSUFFICIENT_STOCK"],"type":"string","xml":{"name":"DiagnosticCode"},"title":"DiagnosticCode"}}}}
```

## The DocumentCategory object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"}}}}
```

## The DocumentHandling object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"}}}}
```

## The DocumentHandlingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DocumentHandlingConfiguration":{"description":"The configuration allows documents that have been added to the document set of a pack job to be added to the process. The configuration sets the section names of the entities to which external documents will be added to. If the configuration set is empty, no external documents will be added to the process.","properties":{"inheritedDocumentConfigurations":{"items":{"$ref":"#/components/schemas/InheritedDocumentConfiguration"},"type":"array"}},"required":["inheritedDocumentConfigurations"],"title":"DocumentHandlingConfiguration","type":"object"},"InheritedDocumentConfiguration":{"properties":{"section":{"$ref":"#/components/schemas/Section"}},"required":["section"],"title":"InheritedDocumentConfiguration","description":"InheritedDocumentConfiguration"},"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"}}}}
```

## The DocumentOperations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DocumentOperations":{"enum":["PRINT","VIEW"],"type":"string","title":"DocumentOperations","description":"DocumentOperations"}}}}
```

## The DocumentSet object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DocumentSet":{"properties":{"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"documents":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/PrintableDocument"},"maxItems":50,"type":"array"},"facilityRef":{"description":"connected facility","type":"string"},"id":{"description":"Unique identifier for the document set","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["id","lastModified","created","version"],"title":"DocumentSet","type":"object","description":"DocumentSet"},"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","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"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"}}}}
```

## The DocumentStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DocumentStatus":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"DocumentStatus","description":"DocumentStatus"}}}}
```

## The DocumentType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"}}}}
```

## The DomainConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DomainConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"},"value":{"description":"User's default domain for authentication","type":"string"}},"required":["value"],"type":"object","title":"DomainConfiguration","description":"DomainConfiguration"},"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"}}}}
```

## The DomainStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"}}}}
```

## The DomainStatusHistoryItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"}}}}
```

## The DomainStatusMappingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DomainStatusMappingConfiguration":{"additionalProperties":false,"deprecated":true,"description":"Set status mapping configuration in their respective domains.","properties":{"pickingMappingConfiguration":{"$ref":"#/components/schemas/PickingDomainStatusConfiguration"}},"type":"object","title":"DomainStatusMappingConfiguration"},"PickingDomainStatusConfiguration":{"additionalProperties":false,"description":"Configuration for the picking status to domainStatus mapping","properties":{"mapAbortedToFinished":{"default":false,"description":"If true, the pickJob status ABORTED will be mapped to the domainStatus FINISHED instead of STUCK","type":"boolean"}},"type":"object","title":"PickingDomainStatusConfiguration"}}}}
```

## The DomainType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"}}}}
```

## The DpdChCarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"DpdChCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"DpdChCarrierConfiguration","type":"object","description":"DpdChCarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The EarliestPickingStart object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"}}}}
```

## The Editor object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"}}}}
```

## The EffectivePermissionsResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"EffectivePermissionsResponse":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRoleWithPermissions"},"type":"array"},"userId":{"description":"User ID of the current user","type":"string"}},"required":["userId","roles"],"title":"EffectivePermissionsResponse","type":"object","description":"EffectivePermissionsResponse"},"UserRoleWithPermissions":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"type":"array"}},"required":["name"],"title":"UserRoleWithPermissions","type":"object","description":"UserRoleWithPermissions"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The EmailNotificationChannel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"}}}}
```

## The EmailNotificationChannelForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"EmailNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","receiver"],"title":"EmailNotificationChannelForCreation","type":"object","description":"EmailNotificationChannelForCreation"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"}}}}
```

## The EmailReceiver object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"}}}}
```

## The Entity object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Entity":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"description":"The id of the entity.","type":"string"}},"required":["id"],"type":"object","title":"Entity","description":"Entity"},"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"}}}}
```

## The EntityLink object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"EntityLink":{"properties":{"ref":{"description":"The reference ID of the linked entity","type":"string"},"type":{"description":"The type of the linked entity","enum":["ORDER","FACILITY","ROUTING_PLAN","PROCESS","PICK_JOB"],"type":"string"}},"required":["ref","type"],"title":"EntityLink","type":"object","description":"EntityLink"}}}}
```

## The ErrorInner object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The EstimatedDeliveryTime object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"EstimatedDeliveryTime":{"properties":{"maxDeliveryDays":{"description":"Maximum total delivery time in days","minimum":0,"type":"integer"},"minDeliveryDays":{"description":"Minimum total delivery time in days","minimum":0,"type":"integer"}},"required":["maxDeliveryDays","minDeliveryDays"],"type":"object","title":"EstimatedDeliveryTime","description":"EstimatedDeliveryTime"}}}}
```

## The ExpectedHandoverLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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":{"allOf":[{"$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"}}}}
```

## The ExpectedHandoverLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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":{"allOf":[{"$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"}}}}
```

## The ExpectedLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ExpectedPickLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpectedPickLineItem":{"allOf":[{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["id"],"type":"object"}],"title":"ExpectedPickLineItem","description":"ExpectedPickLineItem"},"ExpectedPickLineItemForCreation":{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["transferId","quantity","article"],"title":"ExpectedPickLineItemForCreation","description":"ExpectedPickLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The ExpectedPickLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpectedPickLineItemForCreation":{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["transferId","quantity","article"],"title":"ExpectedPickLineItemForCreation","description":"ExpectedPickLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The ExpiryConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpiryConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"provisioningTimeOffsetInMinutes":{"minimum":0,"type":"integer"}},"required":["provisioningTimeOffsetInMinutes"],"type":"object","title":"ExpiryConfiguration","description":"ExpiryConfiguration"},"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"}}}}
```

## The ExpiryEntity object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpiryEntity":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"expiryTime":{"description":"Time where the connected process expires, if not fulfilled","format":"date-time","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"processRef":{"description":"Reference to the Process of this Entity","type":"string"},"processVersion":{"description":"the version of the process this expiry entity belongs to, needed for preventing of faulty changes via late messages","format":"int64","type":"integer"},"provisioningTime":{"description":"Planned time where this entity should be provided or handed over to the customer","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/ExpiryEntityStatus"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["id","version","created","lastModified","processRef","provisioningTime","expiryTime","status"],"title":"ExpiryEntity","description":"ExpiryEntity"},"ExpiryEntityStatus":{"enum":["ACTIVE","INACTIVE"],"type":"string","title":"ExpiryEntityStatus","description":"ExpiryEntityStatus"}}}}
```

## The ExpiryEntityFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpiryEntityFilter":{"additionalProperties":false,"properties":{"endDate":{"description":"end date range for expiryTime","format":"date-time"},"processRef":{"description":"process of the entity you want to load","type":"string"},"startDate":{"description":"start date range for expiryTime","format":"date-time"},"status":{"$ref":"#/components/schemas/ExpiryEntityStatus"}},"title":"ExpiryEntityFilter","description":"ExpiryEntityFilter"},"ExpiryEntityStatus":{"enum":["ACTIVE","INACTIVE"],"type":"string","title":"ExpiryEntityStatus","description":"ExpiryEntityStatus"}}}}
```

## The ExpiryEntityForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpiryEntityForCreation":{"additionalProperties":false,"properties":{"processRef":{"description":"Reference to the Process for which this expiry entity will be created","type":"string"},"provisioningTime":{"description":"Planned time where this entity should be provided or handed over to the customer","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/ExpiryEntityStatus"}},"required":["processRef","provisioningTime","status"],"title":"ExpiryEntityForCreation","description":"ExpiryEntityForCreation"},"ExpiryEntityStatus":{"enum":["ACTIVE","INACTIVE"],"type":"string","title":"ExpiryEntityStatus","description":"ExpiryEntityStatus"}}}}
```

## The ExpiryEntityForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpiryEntityForUpdate":{"additionalProperties":false,"properties":{"provisioningTime":{"description":"Planned time where this entity should be provided or handed over to the customer","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/ExpiryEntityStatus"},"version":{"description":"version of the entity you want to alter","type":"integer"}},"required":["version"],"title":"ExpiryEntityForUpdate","description":"ExpiryEntityForUpdate"},"ExpiryEntityStatus":{"enum":["ACTIVE","INACTIVE"],"type":"string","title":"ExpiryEntityStatus","description":"ExpiryEntityStatus"}}}}
```

## The ExpiryEntityStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpiryEntityStatus":{"enum":["ACTIVE","INACTIVE"],"type":"string","title":"ExpiryEntityStatus","description":"ExpiryEntityStatus"}}}}
```

## The ExpiryWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpiryWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ExpiryEntity"}},"required":["payload"],"type":"object","title":"ExpiryWebHookEvent","description":"ExpiryWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ExpiryEntity":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"expiryTime":{"description":"Time where the connected process expires, if not fulfilled","format":"date-time","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"processRef":{"description":"Reference to the Process of this Entity","type":"string"},"processVersion":{"description":"the version of the process this expiry entity belongs to, needed for preventing of faulty changes via late messages","format":"int64","type":"integer"},"provisioningTime":{"description":"Planned time where this entity should be provided or handed over to the customer","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/ExpiryEntityStatus"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["id","version","created","lastModified","processRef","provisioningTime","expiryTime","status"],"title":"ExpiryEntity","description":"ExpiryEntity"},"ExpiryEntityStatus":{"enum":["ACTIVE","INACTIVE"],"type":"string","title":"ExpiryEntityStatus","description":"ExpiryEntityStatus"}}}}
```

## The ExportContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportContainer":{"properties":{"created":{"description":"Timestamp when the export container was created.","format":"date-time","type":"string"},"customAttributes":{"description":"Arbitrary key-value pairs for storing additional metadata on the container.","type":"object"},"description":{"description":"Optional description providing additional context about the container's purpose.","type":"string"},"id":{"description":"Unique identifier of the export container.","type":"string"},"lastModified":{"description":"Timestamp when the export container was last modified.","format":"date-time","type":"string"},"name":{"description":"Human-readable name of the export container.","type":"string"},"tenantExportContainerId":{"description":"Caller-supplied identifier to correlate this container with an external system.","type":"string"},"version":{"description":"Version number incremented on each update. Used for optimistic concurrency control.","type":"number"}},"required":["id","created","lastModified","version","name"],"title":"ExportContainer","type":"object","description":"ExportContainer"}}}}
```

## The ExportContainerForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportContainerForCreation":{"properties":{"customAttributes":{"description":"Arbitrary key-value pairs for storing additional metadata on the container.","type":"object"},"description":{"description":"Optional description providing additional context about the container's purpose.","type":"string"},"name":{"description":"Human-readable name of the export container.","type":"string"},"tenantExportContainerId":{"description":"Caller-supplied identifier to correlate this container with an external system.","type":"string"}},"required":["name"],"title":"ExportContainerForCreation","type":"object","description":"ExportContainerForCreation"}}}}
```

## The ExportContainerForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportContainerForUpdate":{"properties":{"customAttributes":{"description":"Arbitrary key-value pairs for storing additional metadata on the container.","nullable":true,"type":"object"},"description":{"description":"Optional description providing additional context about the container's purpose.","nullable":true,"type":"string"},"name":{"description":"Human-readable name of the export container.","type":"string"},"tenantExportContainerId":{"description":"Caller-supplied identifier to correlate this container with an external system.","nullable":true,"type":"string"},"version":{"description":"Current version of the export container. Must match the stored version to prevent concurrent update conflicts.","type":"number"}},"required":["version"],"title":"ExportContainerForUpdate","type":"object","description":"ExportContainerForUpdate"}}}}
```

## The ExportContainerPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportContainerPaginatedResult":{"properties":{"exportContainers":{"items":{"$ref":"#/components/schemas/ExportContainer"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","exportContainers"],"title":"ExportContainerPaginatedResult","type":"object","description":"ExportContainerPaginatedResult"},"ExportContainer":{"properties":{"created":{"description":"Timestamp when the export container was created.","format":"date-time","type":"string"},"customAttributes":{"description":"Arbitrary key-value pairs for storing additional metadata on the container.","type":"object"},"description":{"description":"Optional description providing additional context about the container's purpose.","type":"string"},"id":{"description":"Unique identifier of the export container.","type":"string"},"lastModified":{"description":"Timestamp when the export container was last modified.","format":"date-time","type":"string"},"name":{"description":"Human-readable name of the export container.","type":"string"},"tenantExportContainerId":{"description":"Caller-supplied identifier to correlate this container with an external system.","type":"string"},"version":{"description":"Version number incremented on each update. Used for optimistic concurrency control.","type":"number"}},"required":["id","created","lastModified","version","name"],"title":"ExportContainer","type":"object","description":"ExportContainer"}}}}
```

## The ExportContainerSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportContainerSearchPayload":{"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/ExportContainerSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"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":"ExportContainerSearchPayload","type":"object","description":"ExportContainerSearchPayload"},"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"},"ExportContainerSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ExportContainerSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"description":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by description"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/ExportContainerSearchQuery"},"maxItems":500,"type":"array"},"tenantExportContainerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantExportContainerId"}},"title":"ExportContainerSearchQuery","type":"object","description":"ExportContainerSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"}}}}
```

## The ExportContainerSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportContainerSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ExportContainerSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"description":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by description"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/ExportContainerSearchQuery"},"maxItems":500,"type":"array"},"tenantExportContainerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantExportContainerId"}},"title":"ExportContainerSearchQuery","type":"object","description":"ExportContainerSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"}}}}
```

## The ExportOperation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperation":{"properties":{"created":{"description":"Timestamp when the export operation was created.","format":"date-time","type":"string"},"dataFormat":{"description":"Format of the exported data, e.g. JSONL.","enum":["JSONL"],"type":"string"},"error":{"allOf":[{"$ref":"#/components/schemas/ExportOperationError"}],"description":"Error details if the export operation failed.","nullable":true,"type":"object"},"exportRequestRef":{"description":"Reference to the export request that this operation belongs to.","type":"string"},"files":{"description":"Files produced by this export operation, each with a download URL and its expiry.","items":{"$ref":"#/components/schemas/ExportOperationFile"},"type":"array"},"filesDeletionDate":{"description":"Timestamp when the exported files are scheduled to be deleted.","format":"date-time","type":"string"},"filesExpired":{"description":"Whether the exported files have already been deleted and are no longer accessible.","type":"boolean"},"finishedAt":{"description":"Timestamp when the export operation finished, either successfully or with an error.","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the export operation.","type":"string"},"lastModified":{"description":"Timestamp when the export operation was last modified.","format":"date-time","type":"string"},"sourceType":{"description":"Type of the data source that is exported, e.g. FACILITY.","type":"string"},"startedAt":{"description":"Timestamp when the export operation started.","format":"date-time","type":"string"},"status":{"description":"Current status of the export operation.","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"trigger":{"description":"How the export operation was triggered.","enum":["MANUAL"],"type":"string"},"version":{"description":"Version number incremented on each update. Used for optimistic concurrency control.","type":"number"}},"required":["id","created","lastModified","version","exportRequestRef","sourceType","trigger","status","startedAt","filesExpired","dataFormat","files"],"title":"ExportOperation","type":"object","description":"ExportOperation"},"ExportOperationError":{"properties":{"message":{"description":"Error message describing the reason for the export operation failure.","type":"string"}},"required":["message"],"title":"ExportOperationError","type":"object","description":"ExportOperationError"},"ExportOperationFile":{"properties":{"id":{"description":"Unique identifier of the exported file, used to access it via the file download endpoint.","type":"string"},"name":{"description":"Name of the exported file.","type":"string"},"sizeBytes":{"description":"Size of the exported file in bytes.","type":"number"},"uri":{"description":"Download URI of the exported file.","type":"string"}},"required":["id","name","uri","sizeBytes"],"title":"ExportOperationFile","type":"object","description":"ExportOperationFile"}}}}
```

## The ExportOperationError object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperationError":{"properties":{"message":{"description":"Error message describing the reason for the export operation failure.","type":"string"}},"required":["message"],"title":"ExportOperationError","type":"object","description":"ExportOperationError"}}}}
```

## The ExportOperationExportSourceTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperationExportSourceTypeEnumFilter":{"properties":{"eq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"},"in":{"description":"Search by sourceType","items":{"enum":["STOCK_SUMMARY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"}},"title":"ExportOperationExportSourceTypeEnumFilter","type":"object","description":"ExportOperationExportSourceTypeEnumFilter"}}}}
```

## The ExportOperationFile object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperationFile":{"properties":{"id":{"description":"Unique identifier of the exported file, used to access it via the file download endpoint.","type":"string"},"name":{"description":"Name of the exported file.","type":"string"},"sizeBytes":{"description":"Size of the exported file in bytes.","type":"number"},"uri":{"description":"Download URI of the exported file.","type":"string"}},"required":["id","name","uri","sizeBytes"],"title":"ExportOperationFile","type":"object","description":"ExportOperationFile"}}}}
```

## The ExportOperationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperationPaginatedResult":{"properties":{"exportOperations":{"items":{"$ref":"#/components/schemas/ExportOperation"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","exportOperations"],"title":"ExportOperationPaginatedResult","type":"object","description":"ExportOperationPaginatedResult"},"ExportOperation":{"properties":{"created":{"description":"Timestamp when the export operation was created.","format":"date-time","type":"string"},"dataFormat":{"description":"Format of the exported data, e.g. JSONL.","enum":["JSONL"],"type":"string"},"error":{"allOf":[{"$ref":"#/components/schemas/ExportOperationError"}],"description":"Error details if the export operation failed.","nullable":true,"type":"object"},"exportRequestRef":{"description":"Reference to the export request that this operation belongs to.","type":"string"},"files":{"description":"Files produced by this export operation, each with a download URL and its expiry.","items":{"$ref":"#/components/schemas/ExportOperationFile"},"type":"array"},"filesDeletionDate":{"description":"Timestamp when the exported files are scheduled to be deleted.","format":"date-time","type":"string"},"filesExpired":{"description":"Whether the exported files have already been deleted and are no longer accessible.","type":"boolean"},"finishedAt":{"description":"Timestamp when the export operation finished, either successfully or with an error.","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the export operation.","type":"string"},"lastModified":{"description":"Timestamp when the export operation was last modified.","format":"date-time","type":"string"},"sourceType":{"description":"Type of the data source that is exported, e.g. FACILITY.","type":"string"},"startedAt":{"description":"Timestamp when the export operation started.","format":"date-time","type":"string"},"status":{"description":"Current status of the export operation.","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"trigger":{"description":"How the export operation was triggered.","enum":["MANUAL"],"type":"string"},"version":{"description":"Version number incremented on each update. Used for optimistic concurrency control.","type":"number"}},"required":["id","created","lastModified","version","exportRequestRef","sourceType","trigger","status","startedAt","filesExpired","dataFormat","files"],"title":"ExportOperation","type":"object","description":"ExportOperation"},"ExportOperationError":{"properties":{"message":{"description":"Error message describing the reason for the export operation failure.","type":"string"}},"required":["message"],"title":"ExportOperationError","type":"object","description":"ExportOperationError"},"ExportOperationFile":{"properties":{"id":{"description":"Unique identifier of the exported file, used to access it via the file download endpoint.","type":"string"},"name":{"description":"Name of the exported file.","type":"string"},"sizeBytes":{"description":"Size of the exported file in bytes.","type":"number"},"uri":{"description":"Download URI of the exported file.","type":"string"}},"required":["id","name","uri","sizeBytes"],"title":"ExportOperationFile","type":"object","description":"ExportOperationFile"}}}}
```

## The ExportOperationSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperationSearchPayload":{"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/ExportOperationSearchQuery"},"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/ExportOperationSort"},"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":"ExportOperationSearchPayload","type":"object","description":"ExportOperationSearchPayload"},"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"},"ExportOperationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ExportOperationSearchQuery"},"maxItems":500,"type":"array"},"exportRequestRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by exportRequestRef"},"filesDeletionDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by filesDeletionDate"},"filesExpired":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by filesExpired"},"finishedAt":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by finishedAt"},"or":{"items":{"$ref":"#/components/schemas/ExportOperationSearchQuery"},"maxItems":500,"type":"array"},"sourceType":{"allOf":[{"$ref":"#/components/schemas/ExportOperationExportSourceTypeEnumFilter"}],"description":"Search by sourceType"},"startedAt":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by startedAt"},"status":{"allOf":[{"$ref":"#/components/schemas/ExportOperationStatusEnumFilter"}],"description":"Search by status"}},"title":"ExportOperationSearchQuery","type":"object","description":"ExportOperationSearchQuery"},"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"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"ExportOperationExportSourceTypeEnumFilter":{"properties":{"eq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"},"in":{"description":"Search by sourceType","items":{"enum":["STOCK_SUMMARY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"}},"title":"ExportOperationExportSourceTypeEnumFilter","type":"object","description":"ExportOperationExportSourceTypeEnumFilter"},"ExportOperationStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"}},"title":"ExportOperationStatusEnumFilter","type":"object","description":"ExportOperationStatusEnumFilter"},"ExportOperationSort":{"properties":{"filesDeletionDate":{"enum":["ASC","DESC"],"type":"string"},"finishedAt":{"enum":["ASC","DESC"],"type":"string"},"startedAt":{"enum":["ASC","DESC"],"type":"string"}},"title":"ExportOperationSort","type":"object","description":"ExportOperationSort"}}}}
```

## The ExportOperationSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ExportOperationSearchQuery"},"maxItems":500,"type":"array"},"exportRequestRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by exportRequestRef"},"filesDeletionDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by filesDeletionDate"},"filesExpired":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by filesExpired"},"finishedAt":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by finishedAt"},"or":{"items":{"$ref":"#/components/schemas/ExportOperationSearchQuery"},"maxItems":500,"type":"array"},"sourceType":{"allOf":[{"$ref":"#/components/schemas/ExportOperationExportSourceTypeEnumFilter"}],"description":"Search by sourceType"},"startedAt":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by startedAt"},"status":{"allOf":[{"$ref":"#/components/schemas/ExportOperationStatusEnumFilter"}],"description":"Search by status"}},"title":"ExportOperationSearchQuery","type":"object","description":"ExportOperationSearchQuery"},"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"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"ExportOperationExportSourceTypeEnumFilter":{"properties":{"eq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"},"in":{"description":"Search by sourceType","items":{"enum":["STOCK_SUMMARY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"}},"title":"ExportOperationExportSourceTypeEnumFilter","type":"object","description":"ExportOperationExportSourceTypeEnumFilter"},"ExportOperationStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"}},"title":"ExportOperationStatusEnumFilter","type":"object","description":"ExportOperationStatusEnumFilter"}}}}
```

## The ExportOperationSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperationSort":{"properties":{"filesDeletionDate":{"enum":["ASC","DESC"],"type":"string"},"finishedAt":{"enum":["ASC","DESC"],"type":"string"},"startedAt":{"enum":["ASC","DESC"],"type":"string"}},"title":"ExportOperationSort","type":"object","description":"ExportOperationSort"}}}}
```

## The ExportOperationStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportOperationStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"}},"title":"ExportOperationStatusEnumFilter","type":"object","description":"ExportOperationStatusEnumFilter"}}}}
```

## The ExportRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequest":{"properties":{"created":{"description":"Timestamp when the export container was created.","format":"date-time","type":"string"},"customAttributes":{"description":"Arbitrary key-value pairs for storing additional metadata on the container.","type":"object"},"dataFormat":{"description":"Data format of the export request.","enum":["JSONL"],"type":"string"},"exportContainerRef":{"description":"Reference to the export container.","type":"string"},"id":{"description":"Unique identifier of the export container.","type":"string"},"lastModified":{"description":"Timestamp when the export container was last modified.","format":"date-time","type":"string"},"source":{"allOf":[{"$ref":"#/components/schemas/ExportRequestSource"}],"description":"Source of the export request."},"state":{"allOf":[{"$ref":"#/components/schemas/ExportRequestState"}],"description":"State of the export request."},"tenantExportRequestId":{"description":"ID of the tenant export request associated with this container.","type":"string"},"version":{"description":"Version number incremented on each update. Used for optimistic concurrency control.","type":"number"}},"required":["id","created","lastModified","version","exportContainerRef","source","dataFormat","state"],"title":"ExportRequest","type":"object","description":"ExportRequest"},"ExportRequestSource":{"properties":{"type":{"description":"Type of the export request source.","enum":["STOCK_SUMMARY"],"type":"string"}},"required":["type"],"title":"ExportRequestSource","type":"object","description":"ExportRequestSource"},"ExportRequestState":{"properties":{"lastOperationFinishedAt":{"description":"Timestamp when the last operation on the export request finished.","format":"date-time","type":"string"},"lastOperationId":{"description":"ID of the last operation performed on the export request.","type":"string"},"lastOperationStatus":{"description":"Status of the last operation performed on the export request.","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"status":{"description":"Status of the export request.","enum":["IDLE","RUNNING"],"type":"string"}},"required":["status"],"title":"ExportRequestState","type":"object","description":"ExportRequestState"}}}}
```

## The ExportRequestAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestAction":{"properties":{"name":{"description":"Name of the action to perform on the export request.","enum":["TRIGGER_EXPORT"],"type":"string"}},"required":["name"],"title":"ExportRequestAction","type":"object","description":"ExportRequestAction"}}}}
```

## The ExportRequestActionResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestActionResult":{"properties":{"name":{"description":"Name of the action that was performed.","enum":["TRIGGER_EXPORT"],"type":"string"},"result":{"description":"Result of the action performed on the export request.","oneOf":[{"$ref":"#/components/schemas/ExportOperation"}]}},"required":["name","result"],"title":"ExportRequestActionResult","type":"object","description":"ExportRequestActionResult"},"ExportOperation":{"properties":{"created":{"description":"Timestamp when the export operation was created.","format":"date-time","type":"string"},"dataFormat":{"description":"Format of the exported data, e.g. JSONL.","enum":["JSONL"],"type":"string"},"error":{"allOf":[{"$ref":"#/components/schemas/ExportOperationError"}],"description":"Error details if the export operation failed.","nullable":true,"type":"object"},"exportRequestRef":{"description":"Reference to the export request that this operation belongs to.","type":"string"},"files":{"description":"Files produced by this export operation, each with a download URL and its expiry.","items":{"$ref":"#/components/schemas/ExportOperationFile"},"type":"array"},"filesDeletionDate":{"description":"Timestamp when the exported files are scheduled to be deleted.","format":"date-time","type":"string"},"filesExpired":{"description":"Whether the exported files have already been deleted and are no longer accessible.","type":"boolean"},"finishedAt":{"description":"Timestamp when the export operation finished, either successfully or with an error.","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the export operation.","type":"string"},"lastModified":{"description":"Timestamp when the export operation was last modified.","format":"date-time","type":"string"},"sourceType":{"description":"Type of the data source that is exported, e.g. FACILITY.","type":"string"},"startedAt":{"description":"Timestamp when the export operation started.","format":"date-time","type":"string"},"status":{"description":"Current status of the export operation.","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"trigger":{"description":"How the export operation was triggered.","enum":["MANUAL"],"type":"string"},"version":{"description":"Version number incremented on each update. Used for optimistic concurrency control.","type":"number"}},"required":["id","created","lastModified","version","exportRequestRef","sourceType","trigger","status","startedAt","filesExpired","dataFormat","files"],"title":"ExportOperation","type":"object","description":"ExportOperation"},"ExportOperationError":{"properties":{"message":{"description":"Error message describing the reason for the export operation failure.","type":"string"}},"required":["message"],"title":"ExportOperationError","type":"object","description":"ExportOperationError"},"ExportOperationFile":{"properties":{"id":{"description":"Unique identifier of the exported file, used to access it via the file download endpoint.","type":"string"},"name":{"description":"Name of the exported file.","type":"string"},"sizeBytes":{"description":"Size of the exported file in bytes.","type":"number"},"uri":{"description":"Download URI of the exported file.","type":"string"}},"required":["id","name","uri","sizeBytes"],"title":"ExportOperationFile","type":"object","description":"ExportOperationFile"}}}}
```

## The ExportRequestExportDataFormatEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestExportDataFormatEnumFilter":{"properties":{"eq":{"description":"Search by dataFormat","enum":["JSONL"],"type":"string"},"in":{"description":"Search by dataFormat","items":{"enum":["JSONL"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by dataFormat","enum":["JSONL"],"type":"string"}},"title":"ExportRequestExportDataFormatEnumFilter","type":"object","description":"ExportRequestExportDataFormatEnumFilter"}}}}
```

## The ExportRequestExportSourceTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestExportSourceTypeEnumFilter":{"properties":{"eq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"},"in":{"description":"Search by sourceType","items":{"enum":["STOCK_SUMMARY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"}},"title":"ExportRequestExportSourceTypeEnumFilter","type":"object","description":"ExportRequestExportSourceTypeEnumFilter"}}}}
```

## The ExportRequestForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestForCreation":{"properties":{"customAttributes":{"description":"Arbitrary key-value pairs for storing additional metadata on the container.","type":"object"},"dataFormat":{"description":"Data format of the export request.","enum":["JSONL"],"type":"string"},"source":{"allOf":[{"$ref":"#/components/schemas/ExportRequestSource"}],"description":"Source of the export request."},"tenantExportRequestId":{"description":"ID of the tenant export request associated with this container.","type":"string"}},"required":["source","dataFormat"],"title":"ExportRequestForCreation","type":"object","description":"ExportRequestForCreation"},"ExportRequestSource":{"properties":{"type":{"description":"Type of the export request source.","enum":["STOCK_SUMMARY"],"type":"string"}},"required":["type"],"title":"ExportRequestSource","type":"object","description":"ExportRequestSource"}}}}
```

## The ExportRequestForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestForUpdate":{"properties":{"customAttributes":{"description":"Arbitrary key-value pairs for storing additional metadata on the request.","nullable":true,"type":"object"},"source":{"allOf":[{"$ref":"#/components/schemas/ExportRequestSource"}],"description":"Source of the export request."},"tenantExportRequestId":{"description":"ID of the tenant export request associated with this request.","nullable":true,"type":"string"},"version":{"description":"Current version of the export request. Must match the stored version to prevent concurrent update conflicts.","type":"number"}},"required":["version"],"title":"ExportRequestForUpdate","type":"object","description":"ExportRequestForUpdate"},"ExportRequestSource":{"properties":{"type":{"description":"Type of the export request source.","enum":["STOCK_SUMMARY"],"type":"string"}},"required":["type"],"title":"ExportRequestSource","type":"object","description":"ExportRequestSource"}}}}
```

## The ExportRequestPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestPaginatedResult":{"properties":{"exportRequests":{"items":{"$ref":"#/components/schemas/ExportRequest"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","exportRequests"],"title":"ExportRequestPaginatedResult","type":"object","description":"ExportRequestPaginatedResult"},"ExportRequest":{"properties":{"created":{"description":"Timestamp when the export container was created.","format":"date-time","type":"string"},"customAttributes":{"description":"Arbitrary key-value pairs for storing additional metadata on the container.","type":"object"},"dataFormat":{"description":"Data format of the export request.","enum":["JSONL"],"type":"string"},"exportContainerRef":{"description":"Reference to the export container.","type":"string"},"id":{"description":"Unique identifier of the export container.","type":"string"},"lastModified":{"description":"Timestamp when the export container was last modified.","format":"date-time","type":"string"},"source":{"allOf":[{"$ref":"#/components/schemas/ExportRequestSource"}],"description":"Source of the export request."},"state":{"allOf":[{"$ref":"#/components/schemas/ExportRequestState"}],"description":"State of the export request."},"tenantExportRequestId":{"description":"ID of the tenant export request associated with this container.","type":"string"},"version":{"description":"Version number incremented on each update. Used for optimistic concurrency control.","type":"number"}},"required":["id","created","lastModified","version","exportContainerRef","source","dataFormat","state"],"title":"ExportRequest","type":"object","description":"ExportRequest"},"ExportRequestSource":{"properties":{"type":{"description":"Type of the export request source.","enum":["STOCK_SUMMARY"],"type":"string"}},"required":["type"],"title":"ExportRequestSource","type":"object","description":"ExportRequestSource"},"ExportRequestState":{"properties":{"lastOperationFinishedAt":{"description":"Timestamp when the last operation on the export request finished.","format":"date-time","type":"string"},"lastOperationId":{"description":"ID of the last operation performed on the export request.","type":"string"},"lastOperationStatus":{"description":"Status of the last operation performed on the export request.","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"status":{"description":"Status of the export request.","enum":["IDLE","RUNNING"],"type":"string"}},"required":["status"],"title":"ExportRequestState","type":"object","description":"ExportRequestState"}}}}
```

## The ExportRequestSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestSearchPayload":{"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/ExportRequestSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"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":"ExportRequestSearchPayload","type":"object","description":"ExportRequestSearchPayload"},"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"},"ExportRequestSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ExportRequestSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"dataFormat":{"allOf":[{"$ref":"#/components/schemas/ExportRequestExportDataFormatEnumFilter"}],"description":"Search by dataFormat"},"exportContainerRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by exportContainerRef"},"or":{"items":{"$ref":"#/components/schemas/ExportRequestSearchQuery"},"maxItems":500,"type":"array"},"sourceType":{"allOf":[{"$ref":"#/components/schemas/ExportRequestExportSourceTypeEnumFilter"}],"description":"Search by sourceType"},"tenantExportRequestId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantExportRequestId"}},"title":"ExportRequestSearchQuery","type":"object","description":"ExportRequestSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"ExportRequestExportDataFormatEnumFilter":{"properties":{"eq":{"description":"Search by dataFormat","enum":["JSONL"],"type":"string"},"in":{"description":"Search by dataFormat","items":{"enum":["JSONL"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by dataFormat","enum":["JSONL"],"type":"string"}},"title":"ExportRequestExportDataFormatEnumFilter","type":"object","description":"ExportRequestExportDataFormatEnumFilter"},"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"},"ExportRequestExportSourceTypeEnumFilter":{"properties":{"eq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"},"in":{"description":"Search by sourceType","items":{"enum":["STOCK_SUMMARY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"}},"title":"ExportRequestExportSourceTypeEnumFilter","type":"object","description":"ExportRequestExportSourceTypeEnumFilter"}}}}
```

## The ExportRequestSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ExportRequestSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"dataFormat":{"allOf":[{"$ref":"#/components/schemas/ExportRequestExportDataFormatEnumFilter"}],"description":"Search by dataFormat"},"exportContainerRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by exportContainerRef"},"or":{"items":{"$ref":"#/components/schemas/ExportRequestSearchQuery"},"maxItems":500,"type":"array"},"sourceType":{"allOf":[{"$ref":"#/components/schemas/ExportRequestExportSourceTypeEnumFilter"}],"description":"Search by sourceType"},"tenantExportRequestId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantExportRequestId"}},"title":"ExportRequestSearchQuery","type":"object","description":"ExportRequestSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"ExportRequestExportDataFormatEnumFilter":{"properties":{"eq":{"description":"Search by dataFormat","enum":["JSONL"],"type":"string"},"in":{"description":"Search by dataFormat","items":{"enum":["JSONL"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by dataFormat","enum":["JSONL"],"type":"string"}},"title":"ExportRequestExportDataFormatEnumFilter","type":"object","description":"ExportRequestExportDataFormatEnumFilter"},"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"},"ExportRequestExportSourceTypeEnumFilter":{"properties":{"eq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"},"in":{"description":"Search by sourceType","items":{"enum":["STOCK_SUMMARY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by sourceType","enum":["STOCK_SUMMARY"],"type":"string"}},"title":"ExportRequestExportSourceTypeEnumFilter","type":"object","description":"ExportRequestExportSourceTypeEnumFilter"}}}}
```

## The ExportRequestSource object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestSource":{"properties":{"type":{"description":"Type of the export request source.","enum":["STOCK_SUMMARY"],"type":"string"}},"required":["type"],"title":"ExportRequestSource","type":"object","description":"ExportRequestSource"}}}}
```

## The ExportRequestState object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExportRequestState":{"properties":{"lastOperationFinishedAt":{"description":"Timestamp when the last operation on the export request finished.","format":"date-time","type":"string"},"lastOperationId":{"description":"ID of the last operation performed on the export request.","type":"string"},"lastOperationStatus":{"description":"Status of the last operation performed on the export request.","enum":["RUNNING","COMPLETED","FAILED"],"type":"string"},"status":{"description":"Status of the export request.","enum":["IDLE","RUNNING"],"type":"string"}},"required":["status"],"title":"ExportRequestState","type":"object","description":"ExportRequestState"}}}}
```

## The ExpressionGuardCondition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExpressionGuardCondition":{"properties":{"entity":{"description":"Entity the expression applies to","enum":["ORDER","INCOMING_EVENT"],"type":"string"},"expression":{"description":"JSONPath expression evaluated to decide the guard.","type":"string"},"kind":{"description":"Discriminator: expression-based guard.","enum":["EXPRESSION"],"type":"string"}},"required":["kind","expression","entity"],"title":"ExpressionGuardCondition","type":"object","description":"ExpressionGuardCondition"}}}}
```

## The ExternalAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalAction":{"allOf":[{"$ref":"#/components/schemas/ExternalActionForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"description":"The id of this external action. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"name":{"description":"The name of this external action.","type":"string"},"processRef":{"description":"Id of the global process related to this entity.","type":"string"}},"required":["id","name","processRef"],"type":"object","xml":{"name":"ExternalAction"},"title":"ExternalAction","description":"ExternalAction"},"ExternalActionForReplacement":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"action":{"oneOf":[{"$ref":"#/components/schemas/ExternalFormActionDefinition"},{"$ref":"#/components/schemas/ExternalLinkActionDefinition"},{"$ref":"#/components/schemas/ExternalCommentActionDefinition"}],"discriminator":{"propertyName":"type","mapping":{"BLANK_LINK":"#/components/schemas/ExternalLinkActionDefinition","COMMENT":"#/components/schemas/ExternalCommentActionDefinition","FORM":"#/components/schemas/ExternalFormActionDefinition"}}},"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"},"groups":{"items":{"description":"User-defined text strings for grouping external actions","type":"string"},"type":"array"},"version":{"format":"int64","type":"integer"}},"required":["version","nameLocalized","groups","action"],"type":"object","xml":{"name":"ExternalActionForReplacement"},"title":"ExternalActionForReplacement","description":"ExternalActionForReplacement"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ExternalFormActionDefinition":{"additionalProperties":false,"description":"External Form Action.","properties":{"cancel":{"$ref":"#/components/schemas/ExternalFormActionButton"},"elements":{"items":{"anyOf":[{"$ref":"#/components/schemas/ExternalFormActionElement"},{"$ref":"#/components/schemas/ExternalFormActionInputElement"}],"discriminator":{"propertyName":"elementType","mapping":{"HEADLINE":"#/components/schemas/ExternalFormActionElement","SUBHEADLINE":"#/components/schemas/ExternalFormActionElement","TEXT":"#/components/schemas/ExternalFormActionElement","TEXT_INPUT":"#/components/schemas/ExternalFormActionInputElement"}}},"minItems":1,"type":"array"},"success":{"$ref":"#/components/schemas/ExternalFormActionButton"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["elements","type","cancel"],"title":"ExternalFormActionDefinition","type":"object","xml":{"name":"ExternalFormActionDefinition"}},"ExternalFormActionButton":{"additionalProperties":false,"properties":{"labelLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"label":{"type":"string"}},"required":["labelLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionButton","description":"ExternalFormActionButton"},"ExternalFormActionElement":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"style":{"description":"it is only allowed to set a style for elementType TEXT","enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"}},"required":["elementType","titleLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionElement","description":"ExternalFormActionElement"},"ExternalFormActionElementType":{"enum":["TEXT_INPUT","HEADLINE","SUBHEADLINE","TEXT"],"type":"string","title":"ExternalFormActionElementType","description":"ExternalFormActionElementType"},"ExternalFormActionInputElement":{"additionalProperties":false,"description":"External Form Input Action.","properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementId":{"type":"string"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"isMandatory":{"type":"boolean"},"style":{"enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"},"validation":{"anyOf":[{"$ref":"#/components/schemas/StringValidation"},{"$ref":"#/components/schemas/IntegerValidation"},{"$ref":"#/components/schemas/FloatValidation"}],"discriminator":{"propertyName":"validationType","mapping":{"FLOAT":"#/components/schemas/FloatValidation","INTEGER":"#/components/schemas/IntegerValidation","STRING":"#/components/schemas/StringValidation"}}}},"required":["elementId","titleLocalized","elementType"],"title":"ExternalFormActionInputElement","type":"object","xml":{"name":"ExternalFormActionInputElement"}},"StringValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as string.","properties":{"maxLength":{"type":"number"},"minLength":{"type":"number"}},"title":"StringValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"},"IntegerValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as integer.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"IntegerValidation","type":"object"},"FloatValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as float.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"FloatValidation","type":"object"},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"},"ExternalLinkActionDefinition":{"additionalProperties":false,"description":"External Link Action.","properties":{"linkUrl":{"type":"string"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["linkUrl","type"],"title":"ExternalLinkActionDefinition","type":"object","xml":{"name":"ExternalLinkActionDefinition"}},"ExternalCommentActionDefinition":{"additionalProperties":false,"description":"This action provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"isInternal":{"default":false,"description":"Whether or not this action is meant to be internally to the fulfillmenttools platform. If true, an additional entry in the actions dropdown will be added.","type":"boolean"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["type"],"title":"ExternalCommentActionDefinition","type":"object","xml":{"name":"ExternalCommentActionDefinition"}},"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"}}}}
```

## The ExternalActionExecutedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionExecutedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ExternalActionExecutedWebHookEventPayload"}},"required":["payload"],"type":"object","title":"ExternalActionExecutedWebHookEvent","description":"ExternalActionExecutedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ExternalActionExecutedWebHookEventPayload":{"properties":{"actionPayload":{"oneOf":[{"$ref":"#/components/schemas/ExternalLinkActionLogPayload"},{"$ref":"#/components/schemas/ExternalFormActionLogPayload"}],"type":"object"},"editor":{"$ref":"#/components/schemas/Editor"},"externalActionRef":{"type":"string"},"logId":{"type":"string"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["logId","externalActionRef","type","editor","actionPayload"],"type":"object","title":"ExternalActionExecutedWebHookEventPayload","description":"ExternalActionExecutedWebHookEventPayload"},"ExternalLinkActionLogPayload":{"description":"External Link Action Log Payload.","properties":{"linkOpenedAt":{"description":"The date when this link was opened.","format":"date-time","type":"string"}},"required":["linkOpenedAt"],"title":"ExternalLinkActionLogPayload","type":"object","xml":{"name":"ExternalLinkActionLogPayload"}},"ExternalFormActionLogPayload":{"description":"External Form Action Log Payload.","properties":{"elements":{"items":{"$ref":"#/components/schemas/ExternalFormActionLogPayloadElement"},"minItems":1,"type":"array"}},"required":["elements"],"title":"ExternalFormActionLogPayload","type":"object","xml":{"name":"ExternalFormActionLogPayload"}},"ExternalFormActionLogPayloadElement":{"properties":{"elementId":{"type":"string"},"value":{"type":"string"}},"required":["elementId","value"],"type":"object","xml":{"name":"ExternalFormActionLogPayloadElement"},"title":"ExternalFormActionLogPayloadElement","description":"ExternalFormActionLogPayloadElement"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"}}}}
```

## The ExternalActionExecutedWebHookEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionExecutedWebHookEventPayload":{"properties":{"actionPayload":{"oneOf":[{"$ref":"#/components/schemas/ExternalLinkActionLogPayload"},{"$ref":"#/components/schemas/ExternalFormActionLogPayload"}],"type":"object"},"editor":{"$ref":"#/components/schemas/Editor"},"externalActionRef":{"type":"string"},"logId":{"type":"string"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["logId","externalActionRef","type","editor","actionPayload"],"type":"object","title":"ExternalActionExecutedWebHookEventPayload","description":"ExternalActionExecutedWebHookEventPayload"},"ExternalLinkActionLogPayload":{"description":"External Link Action Log Payload.","properties":{"linkOpenedAt":{"description":"The date when this link was opened.","format":"date-time","type":"string"}},"required":["linkOpenedAt"],"title":"ExternalLinkActionLogPayload","type":"object","xml":{"name":"ExternalLinkActionLogPayload"}},"ExternalFormActionLogPayload":{"description":"External Form Action Log Payload.","properties":{"elements":{"items":{"$ref":"#/components/schemas/ExternalFormActionLogPayloadElement"},"minItems":1,"type":"array"}},"required":["elements"],"title":"ExternalFormActionLogPayload","type":"object","xml":{"name":"ExternalFormActionLogPayload"}},"ExternalFormActionLogPayloadElement":{"properties":{"elementId":{"type":"string"},"value":{"type":"string"}},"required":["elementId","value"],"type":"object","xml":{"name":"ExternalFormActionLogPayloadElement"},"title":"ExternalFormActionLogPayloadElement","description":"ExternalFormActionLogPayloadElement"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"}}}}
```

## The ExternalActionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"action":{"oneOf":[{"$ref":"#/components/schemas/ExternalFormActionDefinition"},{"$ref":"#/components/schemas/ExternalLinkActionDefinition"},{"$ref":"#/components/schemas/ExternalCommentActionDefinition"}],"discriminator":{"propertyName":"type","mapping":{"BLANK_LINK":"#/components/schemas/ExternalLinkActionDefinition","COMMENT":"#/components/schemas/ExternalCommentActionDefinition","FORM":"#/components/schemas/ExternalFormActionDefinition"}}},"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"},"groups":{"items":{"description":"User-defined text strings for grouping external actions","type":"string"},"type":"array"},"processRef":{"description":"Id of the global process related to this entity.","type":"string"}},"required":["processRef","nameLocalized","groups","action"],"type":"object","xml":{"name":"ExternalActionForCreation"},"title":"ExternalActionForCreation","description":"ExternalActionForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ExternalFormActionDefinition":{"additionalProperties":false,"description":"External Form Action.","properties":{"cancel":{"$ref":"#/components/schemas/ExternalFormActionButton"},"elements":{"items":{"anyOf":[{"$ref":"#/components/schemas/ExternalFormActionElement"},{"$ref":"#/components/schemas/ExternalFormActionInputElement"}],"discriminator":{"propertyName":"elementType","mapping":{"HEADLINE":"#/components/schemas/ExternalFormActionElement","SUBHEADLINE":"#/components/schemas/ExternalFormActionElement","TEXT":"#/components/schemas/ExternalFormActionElement","TEXT_INPUT":"#/components/schemas/ExternalFormActionInputElement"}}},"minItems":1,"type":"array"},"success":{"$ref":"#/components/schemas/ExternalFormActionButton"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["elements","type","cancel"],"title":"ExternalFormActionDefinition","type":"object","xml":{"name":"ExternalFormActionDefinition"}},"ExternalFormActionButton":{"additionalProperties":false,"properties":{"labelLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"label":{"type":"string"}},"required":["labelLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionButton","description":"ExternalFormActionButton"},"ExternalFormActionElement":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"style":{"description":"it is only allowed to set a style for elementType TEXT","enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"}},"required":["elementType","titleLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionElement","description":"ExternalFormActionElement"},"ExternalFormActionElementType":{"enum":["TEXT_INPUT","HEADLINE","SUBHEADLINE","TEXT"],"type":"string","title":"ExternalFormActionElementType","description":"ExternalFormActionElementType"},"ExternalFormActionInputElement":{"additionalProperties":false,"description":"External Form Input Action.","properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementId":{"type":"string"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"isMandatory":{"type":"boolean"},"style":{"enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"},"validation":{"anyOf":[{"$ref":"#/components/schemas/StringValidation"},{"$ref":"#/components/schemas/IntegerValidation"},{"$ref":"#/components/schemas/FloatValidation"}],"discriminator":{"propertyName":"validationType","mapping":{"FLOAT":"#/components/schemas/FloatValidation","INTEGER":"#/components/schemas/IntegerValidation","STRING":"#/components/schemas/StringValidation"}}}},"required":["elementId","titleLocalized","elementType"],"title":"ExternalFormActionInputElement","type":"object","xml":{"name":"ExternalFormActionInputElement"}},"StringValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as string.","properties":{"maxLength":{"type":"number"},"minLength":{"type":"number"}},"title":"StringValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"},"IntegerValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as integer.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"IntegerValidation","type":"object"},"FloatValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as float.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"FloatValidation","type":"object"},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"},"ExternalLinkActionDefinition":{"additionalProperties":false,"description":"External Link Action.","properties":{"linkUrl":{"type":"string"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["linkUrl","type"],"title":"ExternalLinkActionDefinition","type":"object","xml":{"name":"ExternalLinkActionDefinition"}},"ExternalCommentActionDefinition":{"additionalProperties":false,"description":"This action provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"isInternal":{"default":false,"description":"Whether or not this action is meant to be internally to the fulfillmenttools platform. If true, an additional entry in the actions dropdown will be added.","type":"boolean"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["type"],"title":"ExternalCommentActionDefinition","type":"object","xml":{"name":"ExternalCommentActionDefinition"}}}}}
```

## The ExternalActionForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionForReplacement":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"action":{"oneOf":[{"$ref":"#/components/schemas/ExternalFormActionDefinition"},{"$ref":"#/components/schemas/ExternalLinkActionDefinition"},{"$ref":"#/components/schemas/ExternalCommentActionDefinition"}],"discriminator":{"propertyName":"type","mapping":{"BLANK_LINK":"#/components/schemas/ExternalLinkActionDefinition","COMMENT":"#/components/schemas/ExternalCommentActionDefinition","FORM":"#/components/schemas/ExternalFormActionDefinition"}}},"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"},"groups":{"items":{"description":"User-defined text strings for grouping external actions","type":"string"},"type":"array"},"version":{"format":"int64","type":"integer"}},"required":["version","nameLocalized","groups","action"],"type":"object","xml":{"name":"ExternalActionForReplacement"},"title":"ExternalActionForReplacement","description":"ExternalActionForReplacement"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ExternalFormActionDefinition":{"additionalProperties":false,"description":"External Form Action.","properties":{"cancel":{"$ref":"#/components/schemas/ExternalFormActionButton"},"elements":{"items":{"anyOf":[{"$ref":"#/components/schemas/ExternalFormActionElement"},{"$ref":"#/components/schemas/ExternalFormActionInputElement"}],"discriminator":{"propertyName":"elementType","mapping":{"HEADLINE":"#/components/schemas/ExternalFormActionElement","SUBHEADLINE":"#/components/schemas/ExternalFormActionElement","TEXT":"#/components/schemas/ExternalFormActionElement","TEXT_INPUT":"#/components/schemas/ExternalFormActionInputElement"}}},"minItems":1,"type":"array"},"success":{"$ref":"#/components/schemas/ExternalFormActionButton"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["elements","type","cancel"],"title":"ExternalFormActionDefinition","type":"object","xml":{"name":"ExternalFormActionDefinition"}},"ExternalFormActionButton":{"additionalProperties":false,"properties":{"labelLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"label":{"type":"string"}},"required":["labelLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionButton","description":"ExternalFormActionButton"},"ExternalFormActionElement":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"style":{"description":"it is only allowed to set a style for elementType TEXT","enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"}},"required":["elementType","titleLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionElement","description":"ExternalFormActionElement"},"ExternalFormActionElementType":{"enum":["TEXT_INPUT","HEADLINE","SUBHEADLINE","TEXT"],"type":"string","title":"ExternalFormActionElementType","description":"ExternalFormActionElementType"},"ExternalFormActionInputElement":{"additionalProperties":false,"description":"External Form Input Action.","properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementId":{"type":"string"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"isMandatory":{"type":"boolean"},"style":{"enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"},"validation":{"anyOf":[{"$ref":"#/components/schemas/StringValidation"},{"$ref":"#/components/schemas/IntegerValidation"},{"$ref":"#/components/schemas/FloatValidation"}],"discriminator":{"propertyName":"validationType","mapping":{"FLOAT":"#/components/schemas/FloatValidation","INTEGER":"#/components/schemas/IntegerValidation","STRING":"#/components/schemas/StringValidation"}}}},"required":["elementId","titleLocalized","elementType"],"title":"ExternalFormActionInputElement","type":"object","xml":{"name":"ExternalFormActionInputElement"}},"StringValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as string.","properties":{"maxLength":{"type":"number"},"minLength":{"type":"number"}},"title":"StringValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"},"IntegerValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as integer.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"IntegerValidation","type":"object"},"FloatValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as float.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"FloatValidation","type":"object"},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"},"ExternalLinkActionDefinition":{"additionalProperties":false,"description":"External Link Action.","properties":{"linkUrl":{"type":"string"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["linkUrl","type"],"title":"ExternalLinkActionDefinition","type":"object","xml":{"name":"ExternalLinkActionDefinition"}},"ExternalCommentActionDefinition":{"additionalProperties":false,"description":"This action provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"isInternal":{"default":false,"description":"Whether or not this action is meant to be internally to the fulfillmenttools platform. If true, an additional entry in the actions dropdown will be added.","type":"boolean"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["type"],"title":"ExternalCommentActionDefinition","type":"object","xml":{"name":"ExternalCommentActionDefinition"}}}}}
```

## The ExternalActionHistoryLogPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionHistoryLogPayload":{"properties":{"groups":{"items":{"type":"string"},"type":"array"}},"required":["groups"],"type":"object","title":"ExternalActionHistoryLogPayload","description":"ExternalActionHistoryLogPayload"}}}}
```

## The ExternalActionLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionLog":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExternalActionLogForCreation"}],"properties":{"created":{"description":"The date this action has been executed","format":"date-time","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"externalActionRef":{"description":"Id of the refered external action.","type":"string"},"id":{"type":"string"}},"required":["id","externalActionRef","editor","created"],"type":"object","xml":{"name":"ExternalActionLog"},"title":"ExternalActionLog","description":"ExternalActionLog"},"ExternalActionLogForCreation":{"properties":{"actionPayload":{"oneOf":[{"$ref":"#/components/schemas/ExternalLinkActionLogPayload"},{"$ref":"#/components/schemas/ExternalFormActionLogPayload"},{"$ref":"#/components/schemas/ExternalCommentActionLogPayload"}]},"requiresAnonymization":{"type":"boolean"}},"required":["requiresAnonymization","actionPayload"],"type":"object","xml":{"name":"ExternalActionLogForCreation"},"title":"ExternalActionLogForCreation","description":"ExternalActionLogForCreation"},"ExternalLinkActionLogPayload":{"description":"External Link Action Log Payload.","properties":{"linkOpenedAt":{"description":"The date when this link was opened.","format":"date-time","type":"string"}},"required":["linkOpenedAt"],"title":"ExternalLinkActionLogPayload","type":"object","xml":{"name":"ExternalLinkActionLogPayload"}},"ExternalFormActionLogPayload":{"description":"External Form Action Log Payload.","properties":{"elements":{"items":{"$ref":"#/components/schemas/ExternalFormActionLogPayloadElement"},"minItems":1,"type":"array"}},"required":["elements"],"title":"ExternalFormActionLogPayload","type":"object","xml":{"name":"ExternalFormActionLogPayload"}},"ExternalFormActionLogPayloadElement":{"properties":{"elementId":{"type":"string"},"value":{"type":"string"}},"required":["elementId","value"],"type":"object","xml":{"name":"ExternalFormActionLogPayloadElement"},"title":"ExternalFormActionLogPayloadElement","description":"ExternalFormActionLogPayloadElement"},"ExternalCommentActionLogPayload":{"additionalProperties":false,"description":"This action payload provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"comment":{"description":"The actual comment.","minLength":1,"type":"string"},"externalActionRef":{"description":"An existing external action id you want to link with. The action have to be in the same process.","minLength":1,"type":"string"}},"required":["comment"],"title":"ExternalCommentActionLogPayload","type":"object","xml":{"name":"ExternalCommentActionLogPayload"}},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"}}}}
```

## The ExternalActionLogForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionLogForCreation":{"properties":{"actionPayload":{"oneOf":[{"$ref":"#/components/schemas/ExternalLinkActionLogPayload"},{"$ref":"#/components/schemas/ExternalFormActionLogPayload"},{"$ref":"#/components/schemas/ExternalCommentActionLogPayload"}]},"requiresAnonymization":{"type":"boolean"}},"required":["requiresAnonymization","actionPayload"],"type":"object","xml":{"name":"ExternalActionLogForCreation"},"title":"ExternalActionLogForCreation","description":"ExternalActionLogForCreation"},"ExternalLinkActionLogPayload":{"description":"External Link Action Log Payload.","properties":{"linkOpenedAt":{"description":"The date when this link was opened.","format":"date-time","type":"string"}},"required":["linkOpenedAt"],"title":"ExternalLinkActionLogPayload","type":"object","xml":{"name":"ExternalLinkActionLogPayload"}},"ExternalFormActionLogPayload":{"description":"External Form Action Log Payload.","properties":{"elements":{"items":{"$ref":"#/components/schemas/ExternalFormActionLogPayloadElement"},"minItems":1,"type":"array"}},"required":["elements"],"title":"ExternalFormActionLogPayload","type":"object","xml":{"name":"ExternalFormActionLogPayload"}},"ExternalFormActionLogPayloadElement":{"properties":{"elementId":{"type":"string"},"value":{"type":"string"}},"required":["elementId","value"],"type":"object","xml":{"name":"ExternalFormActionLogPayloadElement"},"title":"ExternalFormActionLogPayloadElement","description":"ExternalFormActionLogPayloadElement"},"ExternalCommentActionLogPayload":{"additionalProperties":false,"description":"This action payload provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"comment":{"description":"The actual comment.","minLength":1,"type":"string"},"externalActionRef":{"description":"An existing external action id you want to link with. The action have to be in the same process.","minLength":1,"type":"string"}},"required":["comment"],"title":"ExternalCommentActionLogPayload","type":"object","xml":{"name":"ExternalCommentActionLogPayload"}}}}}
```

## The ExternalActionLogs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionLogs":{"additionalProperties":false,"properties":{"externalActionLogs":{"items":{"$ref":"#/components/schemas/ExternalActionLog"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"required":["externalActionLogs","total"],"type":"object","title":"ExternalActionLogs","description":"ExternalActionLogs"},"ExternalActionLog":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExternalActionLogForCreation"}],"properties":{"created":{"description":"The date this action has been executed","format":"date-time","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"externalActionRef":{"description":"Id of the refered external action.","type":"string"},"id":{"type":"string"}},"required":["id","externalActionRef","editor","created"],"type":"object","xml":{"name":"ExternalActionLog"},"title":"ExternalActionLog","description":"ExternalActionLog"},"ExternalActionLogForCreation":{"properties":{"actionPayload":{"oneOf":[{"$ref":"#/components/schemas/ExternalLinkActionLogPayload"},{"$ref":"#/components/schemas/ExternalFormActionLogPayload"},{"$ref":"#/components/schemas/ExternalCommentActionLogPayload"}]},"requiresAnonymization":{"type":"boolean"}},"required":["requiresAnonymization","actionPayload"],"type":"object","xml":{"name":"ExternalActionLogForCreation"},"title":"ExternalActionLogForCreation","description":"ExternalActionLogForCreation"},"ExternalLinkActionLogPayload":{"description":"External Link Action Log Payload.","properties":{"linkOpenedAt":{"description":"The date when this link was opened.","format":"date-time","type":"string"}},"required":["linkOpenedAt"],"title":"ExternalLinkActionLogPayload","type":"object","xml":{"name":"ExternalLinkActionLogPayload"}},"ExternalFormActionLogPayload":{"description":"External Form Action Log Payload.","properties":{"elements":{"items":{"$ref":"#/components/schemas/ExternalFormActionLogPayloadElement"},"minItems":1,"type":"array"}},"required":["elements"],"title":"ExternalFormActionLogPayload","type":"object","xml":{"name":"ExternalFormActionLogPayload"}},"ExternalFormActionLogPayloadElement":{"properties":{"elementId":{"type":"string"},"value":{"type":"string"}},"required":["elementId","value"],"type":"object","xml":{"name":"ExternalFormActionLogPayloadElement"},"title":"ExternalFormActionLogPayloadElement","description":"ExternalFormActionLogPayloadElement"},"ExternalCommentActionLogPayload":{"additionalProperties":false,"description":"This action payload provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"comment":{"description":"The actual comment.","minLength":1,"type":"string"},"externalActionRef":{"description":"An existing external action id you want to link with. The action have to be in the same process.","minLength":1,"type":"string"}},"required":["comment"],"title":"ExternalCommentActionLogPayload","type":"object","xml":{"name":"ExternalCommentActionLogPayload"}},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"}}}}
```

## The ExternalActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActions":{"additionalProperties":false,"properties":{"externalActions":{"items":{"$ref":"#/components/schemas/ExternalAction"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"required":["externalActions","total"],"type":"object","title":"ExternalActions","description":"ExternalActions"},"ExternalAction":{"allOf":[{"$ref":"#/components/schemas/ExternalActionForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"description":"The id of this external action. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"name":{"description":"The name of this external action.","type":"string"},"processRef":{"description":"Id of the global process related to this entity.","type":"string"}},"required":["id","name","processRef"],"type":"object","xml":{"name":"ExternalAction"},"title":"ExternalAction","description":"ExternalAction"},"ExternalActionForReplacement":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"action":{"oneOf":[{"$ref":"#/components/schemas/ExternalFormActionDefinition"},{"$ref":"#/components/schemas/ExternalLinkActionDefinition"},{"$ref":"#/components/schemas/ExternalCommentActionDefinition"}],"discriminator":{"propertyName":"type","mapping":{"BLANK_LINK":"#/components/schemas/ExternalLinkActionDefinition","COMMENT":"#/components/schemas/ExternalCommentActionDefinition","FORM":"#/components/schemas/ExternalFormActionDefinition"}}},"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"},"groups":{"items":{"description":"User-defined text strings for grouping external actions","type":"string"},"type":"array"},"version":{"format":"int64","type":"integer"}},"required":["version","nameLocalized","groups","action"],"type":"object","xml":{"name":"ExternalActionForReplacement"},"title":"ExternalActionForReplacement","description":"ExternalActionForReplacement"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ExternalFormActionDefinition":{"additionalProperties":false,"description":"External Form Action.","properties":{"cancel":{"$ref":"#/components/schemas/ExternalFormActionButton"},"elements":{"items":{"anyOf":[{"$ref":"#/components/schemas/ExternalFormActionElement"},{"$ref":"#/components/schemas/ExternalFormActionInputElement"}],"discriminator":{"propertyName":"elementType","mapping":{"HEADLINE":"#/components/schemas/ExternalFormActionElement","SUBHEADLINE":"#/components/schemas/ExternalFormActionElement","TEXT":"#/components/schemas/ExternalFormActionElement","TEXT_INPUT":"#/components/schemas/ExternalFormActionInputElement"}}},"minItems":1,"type":"array"},"success":{"$ref":"#/components/schemas/ExternalFormActionButton"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["elements","type","cancel"],"title":"ExternalFormActionDefinition","type":"object","xml":{"name":"ExternalFormActionDefinition"}},"ExternalFormActionButton":{"additionalProperties":false,"properties":{"labelLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"label":{"type":"string"}},"required":["labelLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionButton","description":"ExternalFormActionButton"},"ExternalFormActionElement":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"style":{"description":"it is only allowed to set a style for elementType TEXT","enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"}},"required":["elementType","titleLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionElement","description":"ExternalFormActionElement"},"ExternalFormActionElementType":{"enum":["TEXT_INPUT","HEADLINE","SUBHEADLINE","TEXT"],"type":"string","title":"ExternalFormActionElementType","description":"ExternalFormActionElementType"},"ExternalFormActionInputElement":{"additionalProperties":false,"description":"External Form Input Action.","properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementId":{"type":"string"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"isMandatory":{"type":"boolean"},"style":{"enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"},"validation":{"anyOf":[{"$ref":"#/components/schemas/StringValidation"},{"$ref":"#/components/schemas/IntegerValidation"},{"$ref":"#/components/schemas/FloatValidation"}],"discriminator":{"propertyName":"validationType","mapping":{"FLOAT":"#/components/schemas/FloatValidation","INTEGER":"#/components/schemas/IntegerValidation","STRING":"#/components/schemas/StringValidation"}}}},"required":["elementId","titleLocalized","elementType"],"title":"ExternalFormActionInputElement","type":"object","xml":{"name":"ExternalFormActionInputElement"}},"StringValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as string.","properties":{"maxLength":{"type":"number"},"minLength":{"type":"number"}},"title":"StringValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"},"IntegerValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as integer.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"IntegerValidation","type":"object"},"FloatValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as float.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"FloatValidation","type":"object"},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"},"ExternalLinkActionDefinition":{"additionalProperties":false,"description":"External Link Action.","properties":{"linkUrl":{"type":"string"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["linkUrl","type"],"title":"ExternalLinkActionDefinition","type":"object","xml":{"name":"ExternalLinkActionDefinition"}},"ExternalCommentActionDefinition":{"additionalProperties":false,"description":"This action provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"isInternal":{"default":false,"description":"Whether or not this action is meant to be internally to the fulfillmenttools platform. If true, an additional entry in the actions dropdown will be added.","type":"boolean"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["type"],"title":"ExternalCommentActionDefinition","type":"object","xml":{"name":"ExternalCommentActionDefinition"}},"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"}}}}
```

## The ExternalActionType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"}}}}
```

## The ExternalCommentActionDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalCommentActionDefinition":{"additionalProperties":false,"description":"This action provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"isInternal":{"default":false,"description":"Whether or not this action is meant to be internally to the fulfillmenttools platform. If true, an additional entry in the actions dropdown will be added.","type":"boolean"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["type"],"title":"ExternalCommentActionDefinition","type":"object","xml":{"name":"ExternalCommentActionDefinition"}},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"}}}}
```

## The ExternalCommentActionLogPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalCommentActionLogPayload":{"additionalProperties":false,"description":"This action payload provides a possibility to set comments. It also enables a possibility to save action results for other actions.","properties":{"comment":{"description":"The actual comment.","minLength":1,"type":"string"},"externalActionRef":{"description":"An existing external action id you want to link with. The action have to be in the same process.","minLength":1,"type":"string"}},"required":["comment"],"title":"ExternalCommentActionLogPayload","type":"object","xml":{"name":"ExternalCommentActionLogPayload"}}}}}
```

## The ExternalDocument object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalDocument":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"section":{"$ref":"#/components/schemas/Section"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["type","section","id"],"type":"object","title":"ExternalDocument","description":"ExternalDocument"},"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"},"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"}}}}
```

## The ExternalDocumentContentForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalDocumentContentForUpdate":{"properties":{"documentSetVersion":{"description":"Version of documentSet to which this document belongs.","type":"number"},"file":{"$ref":"#/components/schemas/NamedFile"}},"required":["documentSetVersion","file"],"title":"ExternalDocumentContentForUpdate","type":"object","description":"ExternalDocumentContentForUpdate"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"}}}}
```

## The ExternalDocumentForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalDocumentForCreation":{"additionalProperties":false,"properties":{"file":{"$ref":"#/components/schemas/NamedFile"},"priority":{"minimum":0,"type":"number"},"section":{"$ref":"#/components/schemas/Section"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["type","section"],"type":"object","title":"ExternalDocumentForCreation","description":"ExternalDocumentForCreation"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"}}}}
```

## The ExternalDocumentForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalDocumentForUpdate":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"file":{"$ref":"#/components/schemas/NamedFile"}},"required":["file"],"type":"object","title":"ExternalDocumentForUpdate","description":"ExternalDocumentForUpdate"},"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"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"}}}}
```

## The ExternalDocumentInSectionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalDocumentInSectionForCreation":{"additionalProperties":false,"properties":{"file":{"$ref":"#/components/schemas/NamedFile"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["type"],"type":"object","title":"ExternalDocumentInSectionForCreation","description":"ExternalDocumentInSectionForCreation"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"}}}}
```

## The ExternalFormActionButton object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalFormActionButton":{"additionalProperties":false,"properties":{"labelLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"label":{"type":"string"}},"required":["labelLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionButton","description":"ExternalFormActionButton"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ExternalFormActionDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalFormActionDefinition":{"additionalProperties":false,"description":"External Form Action.","properties":{"cancel":{"$ref":"#/components/schemas/ExternalFormActionButton"},"elements":{"items":{"anyOf":[{"$ref":"#/components/schemas/ExternalFormActionElement"},{"$ref":"#/components/schemas/ExternalFormActionInputElement"}],"discriminator":{"propertyName":"elementType","mapping":{"HEADLINE":"#/components/schemas/ExternalFormActionElement","SUBHEADLINE":"#/components/schemas/ExternalFormActionElement","TEXT":"#/components/schemas/ExternalFormActionElement","TEXT_INPUT":"#/components/schemas/ExternalFormActionInputElement"}}},"minItems":1,"type":"array"},"success":{"$ref":"#/components/schemas/ExternalFormActionButton"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["elements","type","cancel"],"title":"ExternalFormActionDefinition","type":"object","xml":{"name":"ExternalFormActionDefinition"}},"ExternalFormActionButton":{"additionalProperties":false,"properties":{"labelLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"label":{"type":"string"}},"required":["labelLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionButton","description":"ExternalFormActionButton"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ExternalFormActionElement":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"style":{"description":"it is only allowed to set a style for elementType TEXT","enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"}},"required":["elementType","titleLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionElement","description":"ExternalFormActionElement"},"ExternalFormActionElementType":{"enum":["TEXT_INPUT","HEADLINE","SUBHEADLINE","TEXT"],"type":"string","title":"ExternalFormActionElementType","description":"ExternalFormActionElementType"},"ExternalFormActionInputElement":{"additionalProperties":false,"description":"External Form Input Action.","properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementId":{"type":"string"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"isMandatory":{"type":"boolean"},"style":{"enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"},"validation":{"anyOf":[{"$ref":"#/components/schemas/StringValidation"},{"$ref":"#/components/schemas/IntegerValidation"},{"$ref":"#/components/schemas/FloatValidation"}],"discriminator":{"propertyName":"validationType","mapping":{"FLOAT":"#/components/schemas/FloatValidation","INTEGER":"#/components/schemas/IntegerValidation","STRING":"#/components/schemas/StringValidation"}}}},"required":["elementId","titleLocalized","elementType"],"title":"ExternalFormActionInputElement","type":"object","xml":{"name":"ExternalFormActionInputElement"}},"StringValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as string.","properties":{"maxLength":{"type":"number"},"minLength":{"type":"number"}},"title":"StringValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"},"IntegerValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as integer.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"IntegerValidation","type":"object"},"FloatValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as float.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"FloatValidation","type":"object"},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"}}}}
```

## The ExternalFormActionElement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalFormActionElement":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"style":{"description":"it is only allowed to set a style for elementType TEXT","enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"}},"required":["elementType","titleLocalized"],"type":"object","xml":{"name":"ExternalFormActionElement"},"title":"ExternalFormActionElement","description":"ExternalFormActionElement"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ExternalFormActionElementType":{"enum":["TEXT_INPUT","HEADLINE","SUBHEADLINE","TEXT"],"type":"string","title":"ExternalFormActionElementType","description":"ExternalFormActionElementType"}}}}
```

## The ExternalFormActionElementType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalFormActionElementType":{"enum":["TEXT_INPUT","HEADLINE","SUBHEADLINE","TEXT"],"type":"string","title":"ExternalFormActionElementType","description":"ExternalFormActionElementType"}}}}
```

## The ExternalFormActionInputElement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalFormActionInputElement":{"additionalProperties":false,"description":"External Form Input Action.","properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString","description":"The name of this external action localized"},"elementId":{"type":"string"},"elementType":{"$ref":"#/components/schemas/ExternalFormActionElementType"},"isMandatory":{"type":"boolean"},"style":{"enum":["BODY","INFO","WARN","ERROR"],"type":"string"},"title":{"type":"string"},"validation":{"anyOf":[{"$ref":"#/components/schemas/StringValidation"},{"$ref":"#/components/schemas/IntegerValidation"},{"$ref":"#/components/schemas/FloatValidation"}],"discriminator":{"propertyName":"validationType","mapping":{"FLOAT":"#/components/schemas/FloatValidation","INTEGER":"#/components/schemas/IntegerValidation","STRING":"#/components/schemas/StringValidation"}}}},"required":["elementId","titleLocalized","elementType"],"title":"ExternalFormActionInputElement","type":"object","xml":{"name":"ExternalFormActionInputElement"}},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ExternalFormActionElementType":{"enum":["TEXT_INPUT","HEADLINE","SUBHEADLINE","TEXT"],"type":"string","title":"ExternalFormActionElementType","description":"ExternalFormActionElementType"},"StringValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as string.","properties":{"maxLength":{"type":"number"},"minLength":{"type":"number"}},"title":"StringValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"},"IntegerValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as integer.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"IntegerValidation","type":"object"},"FloatValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as float.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"FloatValidation","type":"object"}}}}
```

## The ExternalFormActionLogPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalFormActionLogPayload":{"description":"External Form Action Log Payload.","properties":{"elements":{"items":{"$ref":"#/components/schemas/ExternalFormActionLogPayloadElement"},"minItems":1,"type":"array"}},"required":["elements"],"title":"ExternalFormActionLogPayload","type":"object","xml":{"name":"ExternalFormActionLogPayload"}},"ExternalFormActionLogPayloadElement":{"properties":{"elementId":{"type":"string"},"value":{"type":"string"}},"required":["elementId","value"],"type":"object","xml":{"name":"ExternalFormActionLogPayloadElement"},"title":"ExternalFormActionLogPayloadElement","description":"ExternalFormActionLogPayloadElement"}}}}
```

## The ExternalFormActionLogPayloadElement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalFormActionLogPayloadElement":{"properties":{"elementId":{"type":"string"},"value":{"type":"string"}},"required":["elementId","value"],"type":"object","xml":{"name":"ExternalFormActionLogPayloadElement"},"title":"ExternalFormActionLogPayloadElement","description":"ExternalFormActionLogPayloadElement"}}}}
```

## The ExternalLinkActionDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalLinkActionDefinition":{"additionalProperties":false,"description":"External Link Action.","properties":{"linkUrl":{"type":"string"},"type":{"$ref":"#/components/schemas/ExternalActionType"}},"required":["linkUrl","type"],"title":"ExternalLinkActionDefinition","type":"object","xml":{"name":"ExternalLinkActionDefinition"}},"ExternalActionType":{"description":"The type of an external action","enum":["BLANK_LINK","FORM","COMMENT"],"type":"string","title":"ExternalActionType"}}}}
```

## The ExternalLinkActionLogPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalLinkActionLogPayload":{"description":"External Link Action Log Payload.","properties":{"linkOpenedAt":{"description":"The date when this link was opened.","format":"date-time","type":"string"}},"required":["linkOpenedAt"],"title":"ExternalLinkActionLogPayload","type":"object","xml":{"name":"ExternalLinkActionLogPayload"}}}}}
```

## The ExternalPrintableDocumentForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalPrintableDocumentForCreation":{"properties":{"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"},"file":{"$ref":"#/components/schemas/NamedFile"},"operations":{"items":{"enum":["PRINT","VIEW"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"priority":{"type":"number"},"status":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string"},"type":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string"}},"required":["type"],"title":"ExternalPrintableDocumentForCreation","type":"object","description":"ExternalPrintableDocumentForCreation"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"}}}}
```

## The ExternalStockChangeReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalStockChangeReason":{"properties":{"reasonLocalized":{"additionalProperties":{"maxLength":255,"type":"string"},"description":"Localizations, i.e. names which are to be displayed. Each localized string must not exceed 255 characters","type":"object"},"active":{"description":"Whether the reason is active","type":"boolean"},"created":{"description":"Date of creation","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of this external stock change reason","type":"object"},"id":{"description":"Id of the external stock change reason","type":"string"},"lastModified":{"description":"Date of last modification","format":"date-time","type":"string"},"tenantReasonId":{"description":"Identifier of the stock change reason","type":"string"},"version":{"description":"Version of the external stock change reason","type":"number"}},"required":["active","reasonLocalized","id","version"],"title":"ExternalStockChangeReason","type":"object","description":"ExternalStockChangeReason"}}}}
```

## The ExternalStockChangeReasonForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalStockChangeReasonForCreation":{"properties":{"reasonLocalized":{"additionalProperties":{"maxLength":255,"type":"string"},"description":"Localizations, i.e. names which are to be displayed. Each localized string must not exceed 255 characters","type":"object"},"active":{"description":"Whether the reason is active","type":"boolean"},"customAttributes":{"description":"The custom attributes of this external stock change reason","type":"object"},"tenantReasonId":{"description":"Identifier of the stock change reason","type":"string"}},"required":["active","reasonLocalized"],"title":"ExternalStockChangeReasonForCreation","type":"object","description":"ExternalStockChangeReasonForCreation"}}}}
```

## The ExternalStockChangeReasonForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalStockChangeReasonForUpdate":{"properties":{"reasonLocalized":{"additionalProperties":{"maxLength":255,"type":"string"},"description":"Localizations, i.e. names which are to be displayed. Each localized string must not exceed 255 characters","type":"object"},"active":{"description":"Whether the reason is active","type":"boolean"},"customAttributes":{"description":"The custom attributes of this external stock change reason","type":"object"},"id":{"description":"Id of the external stock change reason","type":"string"},"version":{"description":"Version of the external stock change reason","type":"number"}},"required":["version"],"title":"ExternalStockChangeReasonForUpdate","type":"object","description":"ExternalStockChangeReasonForUpdate"}}}}
```

## The ExternalStockChangeReasonInput object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalStockChangeReasonInput":{"properties":{"reasonLocalized":{"description":"List of localized reason strings. If provided, no preconfiguration is necessary. Cannot be provided in combination with id or existing tenantReasonId.","type":"object"},"id":{"description":"ID of reason. Use to enrich with preconfigured reason","type":"string"},"tenantReasonId":{"description":"tenantReasonId of reason. If no reasonLocalized provided, a preconfigured reason with the tenantReasonId must be present","type":"string"}},"title":"ExternalStockChangeReasonInput","type":"object","description":"ExternalStockChangeReasonInput"}}}}
```

## The ExternalStockChangeReasonOutput object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"}}}}
```

## The Facility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"}}}}
```

## The FacilityActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/RemoveFacilityCoordinatesActionParameter"},{"$ref":"#/components/schemas/UpdateFacilityCoordinatesActionParameter"}],"title":"FacilityActionsParameter","description":"FacilityActionsParameter"},"RemoveFacilityCoordinatesActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractFacilityActionsParameter"}],"description":"Remove facility Coordinates.","properties":{"name":{"enum":["REMOVE_FACILITY_COORDINATES"],"type":"string"}},"required":["name","version"],"title":"RemoveFacilityCoordinatesActionParameter"},"AbstractFacilityActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractFacilityActionsParameter","description":"AbstractFacilityActionsParameter"},"UpdateFacilityCoordinatesActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractFacilityActionsParameter"}],"description":"Update facility Coordinates.","properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates"},"name":{"enum":["UPDATE_FACILITY_COORDINATES"],"type":"string"}},"required":["name","coordinates","version"],"title":"UpdateFacilityCoordinatesActionParameter"},"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"}}}}
```

## The FacilityAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The FacilityAddressEmailAddressesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityAddressEmailAddressesFilter":{"properties":{"recipient":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recipient"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityAddressEmailAddressesFilter","type":"object","description":"FacilityAddressEmailAddressesFilter"},"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"}}}}
```

## The FacilityAddressEmailAddressesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityAddressEmailAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityAddressEmailAddressesListFilter","type":"object","description":"FacilityAddressEmailAddressesListFilter"},"FacilityAddressEmailAddressesFilter":{"properties":{"recipient":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recipient"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityAddressEmailAddressesFilter","type":"object","description":"FacilityAddressEmailAddressesFilter"},"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"}}}}
```

## The FacilityAddressFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityAddressFilter":{"properties":{"city":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"emailAddresses":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesListFilter"}],"description":"Nested list search by emailAddresses"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"FacilityAddressFilter","type":"object","description":"FacilityAddressFilter"},"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"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"FacilityAddressEmailAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityAddressEmailAddressesListFilter","type":"object","description":"FacilityAddressEmailAddressesListFilter"},"FacilityAddressEmailAddressesFilter":{"properties":{"recipient":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recipient"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityAddressEmailAddressesFilter","type":"object","description":"FacilityAddressEmailAddressesFilter"}}}}
```

## The FacilityAddressForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"}}}}
```

## The FacilityAddressSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityAddressSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityAddressSort","type":"object","description":"FacilityAddressSort"}}}}
```

## The FacilityCarrierConnection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityCarrierConnection":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"configuration":{"additionalProperties":true,"description":"Carrier-specific configuration","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"credentials":{"additionalProperties":true,"description":"Carrier-specific credentials","type":"object"},"cutoffTime":{"$ref":"#/components/schemas/CutoffTime","description":"Cutoff time configuration"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes","description":"Carrier cutoff times configuration"},"deliveryAreas":{"description":"Delivery areas supported by this connection","items":{"$ref":"#/components/schemas/DeliveryArea"},"type":"array"},"deliveryType":{"description":"Type of delivery service","enum":["SAMEDAY","DELIVERY"],"type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"id":{"description":"Unique identifier for the facility carrier connection","type":"string"},"key":{"description":"Configuration key for the carrier connection","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"name":{"description":"Human-readable name for the connection","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications","items":{"$ref":"#/components/schemas/ParcelLabelClassification"},"type":"array"},"status":{"description":"Status of the carrier connection","enum":["ACTIVE","INACTIVE"],"type":"string"},"validDeliveryTargets":{"description":"Valid delivery targets for this connection","items":{"$ref":"#/components/schemas/DeliveryTarget"},"type":"array"},"version":{"description":"Version number for optimistic locking","type":"number"},"tags":{"description":"Tags associated with the connection","items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","version","created","lastModified","facilityRef","carrierRef","key","status"],"title":"FacilityCarrierConnection","type":"object","description":"FacilityCarrierConnection"},"CutoffTime":{"nullable":true,"properties":{"hour":{"default":12,"type":"number"},"minute":{"default":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"CutoffTime","description":"CutoffTime"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"DeliveryArea":{"properties":{"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"}},"required":["country","postalCode"],"type":"object","title":"DeliveryArea","description":"DeliveryArea"},"ParcelLabelClassification":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"name":{"description":"Name of the parcel label classification","type":"string"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassification","type":"object","description":"ParcelLabelClassification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The FacilityCarrierConnectionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityCarrierConnectionForCreation":{"properties":{"configuration":{"additionalProperties":true,"description":"Carrier-specific configuration","type":"object"},"credentials":{"additionalProperties":true,"description":"Carrier-specific credentials","type":"object"},"cutoffTime":{"$ref":"#/components/schemas/CutoffTime","description":"Cutoff time configuration"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes","description":"Carrier cutoff times configuration"},"deliveryAreas":{"description":"Delivery areas supported by this connection","items":{"$ref":"#/components/schemas/DeliveryArea"},"type":"array"},"name":{"description":"Human-readable name for the connection","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for creation","items":{"$ref":"#/components/schemas/ParcelLabelClassificationForCreation"},"type":"array"},"status":{"description":"Status of the carrier connection","enum":["ACTIVE","INACTIVE"],"type":"string"},"validDeliveryTargets":{"description":"Valid delivery targets for this connection","items":{"$ref":"#/components/schemas/DeliveryTarget"},"type":"array"},"tags":{"description":"Tags associated with the connection","items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"title":"FacilityCarrierConnectionForCreation","type":"object","description":"FacilityCarrierConnectionForCreation"},"CutoffTime":{"nullable":true,"properties":{"hour":{"default":12,"type":"number"},"minute":{"default":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"CutoffTime","description":"CutoffTime"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"DeliveryArea":{"properties":{"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"}},"required":["country","postalCode"],"type":"object","title":"DeliveryArea","description":"DeliveryArea"},"ParcelLabelClassificationForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassificationForCreation","type":"object","description":"ParcelLabelClassificationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The FacilityCarrierConnectionForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityCarrierConnectionForModification":{"properties":{"configuration":{"additionalProperties":true,"description":"Carrier-specific configuration","type":"object"},"credentials":{"additionalProperties":true,"description":"Carrier-specific credentials","type":"object"},"cutoffTime":{"$ref":"#/components/schemas/CutoffTime","description":"Cutoff time configuration"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes","description":"Carrier cutoff times configuration"},"deliveryAreas":{"description":"Delivery areas supported by this connection","items":{"$ref":"#/components/schemas/DeliveryArea"},"type":"array"},"name":{"description":"Human-readable name for the connection","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for creation","items":{"$ref":"#/components/schemas/ParcelLabelClassificationForCreation"},"type":"array"},"status":{"description":"Status of the carrier connection","enum":["ACTIVE","INACTIVE"],"type":"string"},"validDeliveryTargets":{"description":"Valid delivery targets for this connection","items":{"$ref":"#/components/schemas/DeliveryTarget"},"type":"array"},"version":{"description":"Version number for optimistic locking","type":"number"},"tags":{"description":"Tags associated with the connection","items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["version"],"title":"FacilityCarrierConnectionForModification","type":"object","description":"FacilityCarrierConnectionForModification"},"CutoffTime":{"nullable":true,"properties":{"hour":{"default":12,"type":"number"},"minute":{"default":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"CutoffTime","description":"CutoffTime"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"DeliveryArea":{"properties":{"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"}},"required":["country","postalCode"],"type":"object","title":"DeliveryArea","description":"DeliveryArea"},"ParcelLabelClassificationForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassificationForCreation","type":"object","description":"ParcelLabelClassificationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The FacilityContact object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"}}}}
```

## The FacilityContactFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityContactFilter":{"properties":{"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"FacilityContactFilter","type":"object","description":"FacilityContactFilter"},"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"}}}}
```

## The FacilityCreatedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityCreatedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ManagedFacility"}},"required":["payload"],"type":"object","title":"FacilityCreatedWebHookEvent","description":"FacilityCreatedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"}}}}
```

## The FacilityCustomServiceConnection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityCustomServiceConnection":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customServiceRef":{"description":"ID of the custom service this connection belongs to","minLength":1,"type":"string"},"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the facility this connection belongs to","minLength":1,"type":"string"},"id":{"description":"Unique ID of this facility to custom service connection","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"status":{"description":"Status of the connection between facility and custom service","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["status","id","version","created","lastModified","facilityRef","customServiceRef"],"title":"FacilityCustomServiceConnection","type":"object","description":"FacilityCustomServiceConnection"}}}}
```

## The FacilityCustomServiceConnectionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityCustomServiceConnectionForCreation":{"properties":{"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"status":{"description":"Status of the connection between facility and custom service","enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["status"],"title":"FacilityCustomServiceConnectionForCreation","type":"object","description":"FacilityCustomServiceConnectionForCreation"}}}}
```

## The FacilityCustomServiceConnectionForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityCustomServiceConnectionForUpdate":{"properties":{"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"status":{"description":"New status to set for this facility to custom service connection","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"Version of the documentSet you want to update a document of","format":"int64","type":"integer"}},"required":["version"],"title":"FacilityCustomServiceConnectionForUpdate","type":"object","description":"FacilityCustomServiceConnectionForUpdate"}}}}
```

## The FacilityDecision object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDecision":{"properties":{"availabilities":{"items":{"$ref":"#/components/schemas/AvailabilityDuringRouting"},"type":"array"},"facility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"isBestAvailable":{"type":"boolean"},"isBestRated":{"type":"boolean"},"isBestReassignmentCandidate":{"type":"boolean"},"latestPickingStartInformation":{"$ref":"#/components/schemas/LatestPickingStartForDecisionLog"},"orderFences":{"items":{"$ref":"#/components/schemas/OrderFenceDecision"},"type":"array"},"orderLineItemFences":{"items":{"$ref":"#/components/schemas/OrderLineItemFenceDecisions"},"type":"array"},"orderRatings":{"items":{"$ref":"#/components/schemas/OrderRatingDecision"},"type":"array"},"rank":{"type":"number"},"totalPenalty":{"type":"number"}},"required":["facility","orderFences","orderLineItemFences","orderRatings","orderLineItemRatings","availabilities"],"title":"FacilityDecision","description":"FacilityDecision"},"AvailabilityDuringRouting":{"properties":{"articleTitle":{"type":"string"},"available":{"type":"number"},"availablePostRerouteAdjustment":{"type":"number"},"bundleInformation":{"items":{"$ref":"#/components/schemas/BundleInformation"},"type":"array"},"isBackOrderable":{"default":false,"type":"boolean"},"preOrderDate":{"format":"date-time","type":"string"},"requestedQuantity":{"type":"number"},"rerouteInformation":{"$ref":"#/components/schemas/AvailabilityDuringRerouteStock"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","requestedQuantity","available","isBackOrderable"],"title":"AvailabilityDuringRouting","description":"AvailabilityDuringRouting"},"BundleInformation":{"properties":{"customServiceNodeId":{"type":"string"},"requestedQuantity":{"type":"number"}},"required":["customServiceNodeId","requestedQuantity"],"title":"BundleInformation","description":"BundleInformation"},"AvailabilityDuringRerouteStock":{"properties":{"pickedQuantity":{"type":"number"},"rerouteReason":{"$ref":"#/components/schemas/RerouteReason"}},"title":"AvailabilityDuringRerouteStock","description":"AvailabilityDuringRerouteStock"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"DecisionLogFacilityInfo":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"required":["name","facilityRef"],"title":"DecisionLogFacilityInfo","description":"DecisionLogFacilityInfo"},"LatestPickingStartForDecisionLog":{"properties":{"carrierRef":{"type":"string"},"latestPickingStartDate":{"format":"date-time","type":"string"},"lpsCalculationHints":{"description":"@deprecated, use hints","items":{"type":"string"},"type":"array"},"targetTime":{"format":"date-time","type":"string"}},"type":"object","title":"LatestPickingStartForDecisionLog","description":"LatestPickingStartForDecisionLog"},"OrderFenceDecision":{"properties":{"decision":{"$ref":"#/components/schemas/FenceResultStatus"},"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/OrderFenceDecisionDetail"},{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"name":{"type":"string"}},"required":["name","decision","details"],"type":"object","title":"OrderFenceDecision","description":"OrderFenceDecision"},"FenceResultStatus":{"enum":["FAILED","PASSED","REACTIVE_PASSING_POSSIBLE"],"title":"FenceResultStatus","description":"FenceResultStatus"},"OrderFenceDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Order Fence Decision Detail.","properties":{"actualValue":{"type":"string"},"contextReference":{"$ref":"#/components/schemas/ContextReference"},"expectedValue":{"type":"string"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"}},"required":["expectedValue","decisionType"],"title":"OrderFenceDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ContextReference":{"properties":{"reference":{"type":"string"},"routingDecisionContext":{"$ref":"#/components/schemas/RoutingDecisionContext"}},"required":["reference","routingDecisionContext"],"title":"ContextReference","description":"ContextReference"},"RoutingDecisionContext":{"enum":["LISTING","CARRIER"],"title":"RoutingDecisionContext","description":"RoutingDecisionContext"},"ReactiveErrorReason":{"enum":["BACKORDER_LISTING","PREORDER_LISTING"],"title":"ReactiveErrorReason","description":"ReactiveErrorReason"},"ToolkitDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Decision Detail.","properties":{"comparisonOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleOperatorResultExplanation"},"leftPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"leftSideEvaluation":{"type":"boolean"},"rightPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"rightSideEvaluation":{"type":"boolean"}},"required":["decisionType","leftSideEvaluation","description"],"title":"ToolkitDecisionDetail"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitRuleOperatorResultExplanation":{"enum":["SKIPPED","BOTH_CONDITIONS_MET","ONLY_FIRST_CONDITION_MET","ONLY_SECOND_CONDITION_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleOperatorResultExplanation","description":"ToolkitRuleOperatorResultExplanation"},"ToolkitPredicatesDecisionDetail":{"properties":{"connector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicateDecisionDetail"},"type":"array"}},"required":["connector","predicates"],"title":"ToolkitPredicatesDecisionDetail","description":"ToolkitPredicatesDecisionDetail"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitComparisonDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Comparison Decision Detail.","properties":{"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolKitComparisonDetails"},"type":"array"}},"required":["predicates","predicateConnector","description"],"title":"ToolkitComparisonDecisionDetail"},"ToolkitRuleComparePropertiesOperatorResultExplanation":{"enum":["ALL_PREDICATES_MET","NOT_ALL_PREDICATES_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleComparePropertiesOperatorResultExplanation","description":"ToolkitRuleComparePropertiesOperatorResultExplanation"},"ToolKitComparisonDetails":{"properties":{"evaluationResult":{"type":"boolean"},"leftPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"},"predicate":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"rightPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"}},"required":["leftPart","rightPart","evaluationResult","predicate"],"title":"ToolKitComparisonDetails","description":"ToolKitComparisonDetails"},"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"OrderLineItemFenceDecisions":{"properties":{"name":{"type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemFenceDecision"},"type":"array"}},"required":["name","orderLineItems"],"title":"OrderLineItemFenceDecisions","description":"OrderLineItemFenceDecisions"},"OrderLineItemFenceDecision":{"properties":{"articleTitle":{"type":"string"},"decision":{"$ref":"#/components/schemas/FenceResultStatus"},"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/OrderFenceDecisionDetail"},{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","articleTitle","decision","details"],"type":"object","title":"OrderLineItemFenceDecision","description":"OrderLineItemFenceDecision"},"OrderRatingDecision":{"properties":{"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"maxPenalty":{"type":"number"},"name":{"type":"string"},"normalizedScore":{"type":"number"},"score":{"type":"number"}},"required":["name","normalizedScore","maxPenalty"],"type":"object","title":"OrderRatingDecision","description":"OrderRatingDecision"}}}}
```

## The FacilityDeletedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDeletedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"description":"The id of the deleted facility","type":"string"}},"required":["payload"],"type":"object","title":"FacilityDeletedWebHookEvent","description":"FacilityDeletedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"}}}}
```

## The FacilityDiscount object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscount":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/FacilityDiscountForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"facilityRef":{"description":"The id of the facility the discount belongs to. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"id":{"description":"The id of the supplier discount. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["facilityRef","discount","priority","type","id"],"title":"FacilityDiscount","description":"FacilityDiscount"},"FacilityDiscountForCreation":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"}},"required":["discount","priority","type"],"title":"FacilityDiscountForCreation","description":"FacilityDiscountForCreation"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"},"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"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"}}}}
```

## The FacilityDiscountAbsolute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The FacilityDiscountAbsoluteElement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The FacilityDiscountAbsoluteForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The FacilityDiscountContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"}}}}
```

## The FacilityDiscountContextTypes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"}}}}
```

## The FacilityDiscountForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountForCreation":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"}},"required":["discount","priority","type"],"title":"FacilityDiscountForCreation","description":"FacilityDiscountForCreation"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"}}}}
```

## The FacilityDiscountForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountForUpdate":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"title":"FacilityDiscountForUpdate","description":"FacilityDiscountForUpdate"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"}}}}
```

## The FacilityDiscountPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountPaginatedResult":{"additionalProperties":false,"properties":{"items":{"description":"The list of discounts that match the search criteria. The list might be empty if no discounts match the search criteria.","items":{"$ref":"#/components/schemas/FacilityDiscount"},"type":"array"},"total":{"description":"The total number of discounts that match the search criteria. This number is not limited by the page size.","format":"int64","type":"integer"}},"required":["items","total"],"title":"FacilityDiscountPaginatedResult","description":"FacilityDiscountPaginatedResult"},"FacilityDiscount":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/FacilityDiscountForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"facilityRef":{"description":"The id of the facility the discount belongs to. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"id":{"description":"The id of the supplier discount. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["facilityRef","discount","priority","type","id"],"title":"FacilityDiscount","description":"FacilityDiscount"},"FacilityDiscountForCreation":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"}},"required":["discount","priority","type"],"title":"FacilityDiscountForCreation","description":"FacilityDiscountForCreation"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"},"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"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"}}}}
```

## The FacilityDiscountPriceType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"}}}}
```

## The FacilityDiscountRelative object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"}}}}
```

## The FacilityDiscountType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscountType":{"description":"The type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["ABSOLUTE","RELATIVE"],"type":"string","title":"FacilityDiscountType"}}}}
```

## The FacilityFacilityCarrierConnectionFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityFacilityCarrierConnectionFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Filter facilities by configured carrier key"}},"title":"FacilityFacilityCarrierConnectionFilter","type":"object","description":"FacilityFacilityCarrierConnectionFilter"},"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"}}}}
```

## The FacilityForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The FacilityGroup object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"}}}}
```

## The FacilityGroupCreatedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupCreatedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/FacilityGroup"}},"required":["payload"],"type":"object","title":"FacilityGroupCreatedWebHookEvent","description":"FacilityGroupCreatedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"}}}}
```

## The FacilityGroupDeletedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupDeletedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"description":"The id of the deleted facility group","type":"string"}},"required":["payload"],"type":"object","title":"FacilityGroupDeletedWebHookEvent","description":"FacilityGroupDeletedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"}}}}
```

## The FacilityGroupForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupForCreation":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized"],"title":"FacilityGroupForCreation","type":"object","description":"FacilityGroupForCreation"}}}}
```

## The FacilityGroupForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupForUpdate":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"number"}},"required":["version"],"title":"FacilityGroupForUpdate","type":"object","description":"FacilityGroupForUpdate"}}}}
```

## The FacilityGroupPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupPaginatedResult":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/FacilityGroup"},"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","facilityGroups"],"title":"FacilityGroupPaginatedResult","type":"object","description":"FacilityGroupPaginatedResult"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"},"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"}}}}
```

## The FacilityGroups object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroups":{"properties":{"facilityGroups":{"description":"Array of facility groups","items":{"$ref":"#/components/schemas/FacilityGroup"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"number"}},"title":"FacilityGroups","type":"object","description":"FacilityGroups"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"}}}}
```

## The FacilityGroupSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupSearchPayload":{"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/FacilityGroupSearchQuery"},"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/FacilityGroupSort"},"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":"FacilityGroupSearchPayload","type":"object","description":"FacilityGroupSearchPayload"},"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"},"FacilityGroupSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"maxItems":500,"type":"array"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"maxItems":500,"type":"array"},"tenantFacilityGroupId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantFacilityGroupId"}},"title":"FacilityGroupSearchQuery","type":"object","description":"FacilityGroupSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"LocalizedStringSearchFilter":{"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":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"},"FacilityGroupSort":{"properties":{"facilityCount":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantFacilityGroupId":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityGroupSort","type":"object","description":"FacilityGroupSort"}}}}
```

## The FacilityGroupSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"maxItems":500,"type":"array"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"maxItems":500,"type":"array"},"tenantFacilityGroupId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantFacilityGroupId"}},"title":"FacilityGroupSearchQuery","type":"object","description":"FacilityGroupSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"LocalizedStringSearchFilter":{"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":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"}}}}
```

## The FacilityGroupSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupSort":{"properties":{"facilityCount":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantFacilityGroupId":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityGroupSort","type":"object","description":"FacilityGroupSort"}}}}
```

## The FacilityGroupUpdatedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroupUpdatedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/FacilityGroup"}},"required":["payload"],"type":"object","title":"FacilityGroupUpdatedWebHookEvent","description":"FacilityGroupUpdatedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"}}}}
```

## The FacilityLocationType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"}}}}
```

## The FacilityLocationTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"in":{"description":"Search by locationType","items":{"enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"}},"title":"FacilityLocationTypeEnumFilter","type":"object","description":"FacilityLocationTypeEnumFilter"}}}}
```

## The FacilityOperativeCost object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The FacilityOperativeCostForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The FacilityOrderBy object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityOrderBy":{"description":"Attribute to order a facility list","enum":["NAME","CREATED","POSTAL_CODE_ASC"],"type":"string","xml":{"name":"FacilityOrderBy"},"title":"FacilityOrderBy"}}}}
```

## The FacilityPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityPaginatedResult":{"properties":{"facilities":{"items":{"oneOf":[{"$ref":"#/components/schemas/ManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]},"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","facilities"],"title":"FacilityPaginatedResult","type":"object","description":"FacilityPaginatedResult"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"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"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"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"}}}}
```

## The FacilityPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityPatchActions":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated; works only on managed facilities. Prefer to use ManagedFacilityForModification / SupplierForModification for full compatibility.","properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyFacility"},"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":"FacilityPatchActions"},"title":"FacilityPatchActions","deprecated":true},"ModifyFacility":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyFacility', because you want to modify a facility","enum":["ModifyFacility"],"type":"string"},"address":{"$ref":"#/components/schemas/ModifyFacilityAddress"},"capacityEnabled":{"type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"fulfillmentProcessBuffer":{"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"properties":{"type":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"required":["type"],"type":"object"},"type":"array"},"status":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyFacility"},"title":"ModifyFacility","description":"ModifyFacility"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"ModifyFacilityAddress":{"allOf":[{"$ref":"#/components/schemas/ModifyAddress"},{"type":"object"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object"},"type":"array"}},"type":"object"}],"title":"ModifyFacilityAddress","description":"ModifyFacilityAddress"},"ModifyAddress":{"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"}},"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"street":{"pattern":"^.+$","type":"string"}},"type":"object","title":"ModifyAddress","description":"ModifyAddress"},"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"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The FacilityReferenceFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityReferenceFilter":{"properties":{"facilityCarrierConnection":{"allOf":[{"$ref":"#/components/schemas/FacilityFacilityCarrierConnectionFilter"}],"description":"The referenced entity"}},"title":"FacilityReferenceFilter","type":"object","description":"FacilityReferenceFilter"},"FacilityFacilityCarrierConnectionFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Filter facilities by configured carrier key"}},"title":"FacilityFacilityCarrierConnectionFilter","type":"object","description":"FacilityFacilityCarrierConnectionFilter"},"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"}}}}
```

## The FacilityRefLatestPickingStartPair object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityRefLatestPickingStartPair":{"properties":{"facilityRef":{"description":"Facility reference","type":"string"},"latestPickingStart":{"description":"Latest picking start date-time","format":"date-time","type":"string"}},"required":["facilityRef","latestPickingStart"],"title":"FacilityRefLatestPickingStartPair","type":"object","description":"FacilityRefLatestPickingStartPair"}}}}
```

## The FacilityRefSelector object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"}}}}
```

## The FacilitySearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilitySearchPayload":{"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/FacilitySearchQuery"},"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/FacilitySort"},"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":"FacilitySearchPayload","type":"object","description":"FacilitySearchPayload"},"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"},"FacilitySearchQuery":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressFilter"}],"description":"Nested search by address"},"and":{"items":{"$ref":"#/components/schemas/FacilitySearchQuery"},"maxItems":500,"type":"array"},"contact":{"allOf":[{"$ref":"#/components/schemas/FacilityContactFilter"}],"description":"Nested search by contact"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityGroupIds":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Filter facilities by facility group membership"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"locationType":{"allOf":[{"$ref":"#/components/schemas/FacilityLocationTypeEnumFilter"}],"description":"Search by locationType"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/FacilitySearchQuery"},"maxItems":500,"type":"array"},"referenced":{"allOf":[{"$ref":"#/components/schemas/FacilityReferenceFilter"}],"description":"References to other entities"},"services":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesListFilter"}],"description":"Nested list search by services"},"status":{"allOf":[{"$ref":"#/components/schemas/FacilityStatusEnumFilter"}],"description":"Search by status"},"tenantFacilityId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantFacilityId"},"type":{"allOf":[{"$ref":"#/components/schemas/FacilityTypeEnumFilter"}],"description":"Search by type"},"tags":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsListFilter"}],"description":"Nested list search by tags"}},"title":"FacilitySearchQuery","type":"object","description":"FacilitySearchQuery"},"FacilityAddressFilter":{"properties":{"city":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"emailAddresses":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesListFilter"}],"description":"Nested list search by emailAddresses"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"FacilityAddressFilter","type":"object","description":"FacilityAddressFilter"},"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"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"FacilityAddressEmailAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityAddressEmailAddressesListFilter","type":"object","description":"FacilityAddressEmailAddressesListFilter"},"FacilityAddressEmailAddressesFilter":{"properties":{"recipient":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recipient"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityAddressEmailAddressesFilter","type":"object","description":"FacilityAddressEmailAddressesFilter"},"FacilityContactFilter":{"properties":{"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"FacilityContactFilter","type":"object","description":"FacilityContactFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"FacilityLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"in":{"description":"Search by locationType","items":{"enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"}},"title":"FacilityLocationTypeEnumFilter","type":"object","description":"FacilityLocationTypeEnumFilter"},"FacilityReferenceFilter":{"properties":{"facilityCarrierConnection":{"allOf":[{"$ref":"#/components/schemas/FacilityFacilityCarrierConnectionFilter"}],"description":"The referenced entity"}},"title":"FacilityReferenceFilter","type":"object","description":"FacilityReferenceFilter"},"FacilityFacilityCarrierConnectionFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Filter facilities by configured carrier key"}},"title":"FacilityFacilityCarrierConnectionFilter","type":"object","description":"FacilityFacilityCarrierConnectionFilter"},"FacilityServicesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityServicesListFilter","type":"object","description":"FacilityServicesListFilter"},"FacilityServicesFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFacilityServiceTypeEnumFilter"}],"description":"Search by type"}},"title":"FacilityServicesFilter","type":"object","description":"FacilityServicesFilter"},"FacilityServicesFacilityServiceTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"title":"FacilityServicesFacilityServiceTypeEnumFilter","type":"object","description":"FacilityServicesFacilityServiceTypeEnumFilter"},"FacilityStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"}},"title":"FacilityStatusEnumFilter","type":"object","description":"FacilityStatusEnumFilter"},"FacilityTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"}},"title":"FacilityTypeEnumFilter","type":"object","description":"FacilityTypeEnumFilter"},"FacilityTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityTagsListFilter","type":"object","description":"FacilityTagsListFilter"},"FacilityTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityTagsFilter","type":"object","description":"FacilityTagsFilter"},"FacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressSort"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"id":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"locationType":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"services":{"$ref":"#/components/schemas/FacilityServicesSort"},"status":{"enum":["ASC","DESC"],"type":"string"},"tenantFacilityId":{"enum":["ASC","DESC"],"type":"string"},"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilitySort","type":"object","description":"FacilitySort"},"FacilityAddressSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityAddressSort","type":"object","description":"FacilityAddressSort"},"FacilityServicesSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityServicesSort","type":"object","description":"FacilityServicesSort"}}}}
```

## The FacilitySearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilitySearchQuery":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressFilter"}],"description":"Nested search by address"},"and":{"items":{"$ref":"#/components/schemas/FacilitySearchQuery"},"maxItems":500,"type":"array"},"contact":{"allOf":[{"$ref":"#/components/schemas/FacilityContactFilter"}],"description":"Nested search by contact"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityGroupIds":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Filter facilities by facility group membership"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"locationType":{"allOf":[{"$ref":"#/components/schemas/FacilityLocationTypeEnumFilter"}],"description":"Search by locationType"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/FacilitySearchQuery"},"maxItems":500,"type":"array"},"referenced":{"allOf":[{"$ref":"#/components/schemas/FacilityReferenceFilter"}],"description":"References to other entities"},"services":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesListFilter"}],"description":"Nested list search by services"},"status":{"allOf":[{"$ref":"#/components/schemas/FacilityStatusEnumFilter"}],"description":"Search by status"},"tenantFacilityId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantFacilityId"},"type":{"allOf":[{"$ref":"#/components/schemas/FacilityTypeEnumFilter"}],"description":"Search by type"},"tags":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsListFilter"}],"description":"Nested list search by tags"}},"title":"FacilitySearchQuery","type":"object","description":"FacilitySearchQuery"},"FacilityAddressFilter":{"properties":{"city":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"emailAddresses":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesListFilter"}],"description":"Nested list search by emailAddresses"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"FacilityAddressFilter","type":"object","description":"FacilityAddressFilter"},"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"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"FacilityAddressEmailAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityAddressEmailAddressesListFilter","type":"object","description":"FacilityAddressEmailAddressesListFilter"},"FacilityAddressEmailAddressesFilter":{"properties":{"recipient":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recipient"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityAddressEmailAddressesFilter","type":"object","description":"FacilityAddressEmailAddressesFilter"},"FacilityContactFilter":{"properties":{"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"FacilityContactFilter","type":"object","description":"FacilityContactFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"FacilityLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"in":{"description":"Search by locationType","items":{"enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"}},"title":"FacilityLocationTypeEnumFilter","type":"object","description":"FacilityLocationTypeEnumFilter"},"FacilityReferenceFilter":{"properties":{"facilityCarrierConnection":{"allOf":[{"$ref":"#/components/schemas/FacilityFacilityCarrierConnectionFilter"}],"description":"The referenced entity"}},"title":"FacilityReferenceFilter","type":"object","description":"FacilityReferenceFilter"},"FacilityFacilityCarrierConnectionFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Filter facilities by configured carrier key"}},"title":"FacilityFacilityCarrierConnectionFilter","type":"object","description":"FacilityFacilityCarrierConnectionFilter"},"FacilityServicesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityServicesListFilter","type":"object","description":"FacilityServicesListFilter"},"FacilityServicesFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFacilityServiceTypeEnumFilter"}],"description":"Search by type"}},"title":"FacilityServicesFilter","type":"object","description":"FacilityServicesFilter"},"FacilityServicesFacilityServiceTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"title":"FacilityServicesFacilityServiceTypeEnumFilter","type":"object","description":"FacilityServicesFacilityServiceTypeEnumFilter"},"FacilityStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"}},"title":"FacilityStatusEnumFilter","type":"object","description":"FacilityStatusEnumFilter"},"FacilityTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"}},"title":"FacilityTypeEnumFilter","type":"object","description":"FacilityTypeEnumFilter"},"FacilityTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityTagsListFilter","type":"object","description":"FacilityTagsListFilter"},"FacilityTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityTagsFilter","type":"object","description":"FacilityTagsFilter"}}}}
```

## The FacilityService object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"}}}}
```

## The FacilityServicesFacilityServiceTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityServicesFacilityServiceTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"title":"FacilityServicesFacilityServiceTypeEnumFilter","type":"object","description":"FacilityServicesFacilityServiceTypeEnumFilter"}}}}
```

## The FacilityServicesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityServicesFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFacilityServiceTypeEnumFilter"}],"description":"Search by type"}},"title":"FacilityServicesFilter","type":"object","description":"FacilityServicesFilter"},"FacilityServicesFacilityServiceTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"title":"FacilityServicesFacilityServiceTypeEnumFilter","type":"object","description":"FacilityServicesFacilityServiceTypeEnumFilter"}}}}
```

## The FacilityServicesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityServicesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityServicesListFilter","type":"object","description":"FacilityServicesListFilter"},"FacilityServicesFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFacilityServiceTypeEnumFilter"}],"description":"Search by type"}},"title":"FacilityServicesFilter","type":"object","description":"FacilityServicesFilter"},"FacilityServicesFacilityServiceTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"title":"FacilityServicesFacilityServiceTypeEnumFilter","type":"object","description":"FacilityServicesFacilityServiceTypeEnumFilter"}}}}
```

## The FacilityServicesSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityServicesSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityServicesSort","type":"object","description":"FacilityServicesSort"}}}}
```

## The FacilityServiceType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"}}}}
```

## The FacilitySort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressSort"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"id":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"locationType":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"services":{"$ref":"#/components/schemas/FacilityServicesSort"},"status":{"enum":["ASC","DESC"],"type":"string"},"tenantFacilityId":{"enum":["ASC","DESC"],"type":"string"},"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilitySort","type":"object","description":"FacilitySort"},"FacilityAddressSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityAddressSort","type":"object","description":"FacilityAddressSort"},"FacilityServicesSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityServicesSort","type":"object","description":"FacilityServicesSort"}}}}
```

## The FacilityStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"}}}}
```

## The FacilityStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"}},"title":"FacilityStatusEnumFilter","type":"object","description":"FacilityStatusEnumFilter"}}}}
```

## The FacilityStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStock":{"properties":{"available":{"type":"number"},"facilityRef":{"type":"string"},"id":{"type":"string"},"reserved":{"type":"number"},"tenantArticleId":{"type":"string"},"value":{"type":"number"}},"required":["available","reserved","value","tenantArticleId","facilityRef","id"],"title":"FacilityStock","type":"object","description":"FacilityStock"}}}}
```

## The FacilityStockBulkOperation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStockBulkOperation":{"properties":{"tenantArticleId":{"minLength":1,"type":"string"},"value":{"minimum":0,"type":"number"}},"required":["tenantArticleId","value"],"title":"FacilityStockBulkOperation","type":"object","description":"FacilityStockBulkOperation"}}}}
```

## The FacilityStockBulkOperations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStockBulkOperations":{"properties":{"operations":{"items":{"$ref":"#/components/schemas/FacilityStockBulkOperation"},"minItems":1,"type":"array"}},"required":["operations"],"title":"FacilityStockBulkOperations","type":"object","description":"FacilityStockBulkOperations"},"FacilityStockBulkOperation":{"properties":{"tenantArticleId":{"minLength":1,"type":"string"},"value":{"minimum":0,"type":"number"}},"required":["tenantArticleId","value"],"title":"FacilityStockBulkOperation","type":"object","description":"FacilityStockBulkOperation"}}}}
```

## The FacilityStockBulkResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStockBulkResult":{"properties":{"error":{"$ref":"#/components/schemas/BulkOperationError"},"facilityRef":{"type":"string"},"status":{"enum":["UPDATED","CREATED","FAILED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","facilityRef","status"],"title":"FacilityStockBulkResult","type":"object","description":"FacilityStockBulkResult"},"BulkOperationError":{"properties":{"message":{"type":"string"},"type":{"enum":["NOT_FOUND","NOT_ALLOWED","VALIDATION","UNKNOWN"],"type":"string"}},"required":["type","message"],"title":"BulkOperationError","type":"object","description":"BulkOperationError"}}}}
```

## The FacilityStockConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStockConfiguration":{"properties":{"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"id":{"description":"The facility stock configuration ID (same as facility ID)","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"listingReactivationAfter":{"allOf":[{"$ref":"#/components/schemas/FacilityStockConfigurationListingReactivationAfter"}],"deprecated":true,"description":"Configuration for listing reactivation timing"},"retainedOfflineStock":{"allOf":[{"$ref":"#/components/schemas/FacilityStockConfigurationRetainedOfflineStock"}],"deprecated":true,"description":"Configuration for retained offline stock. Deprecated: Use safety stock instead."},"shortpick":{"allOf":[{"$ref":"#/components/schemas/FacilityStockConfigurationShortpick"}],"description":"Configuration for shortpick handling"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["id","version","listingReactivationAfter","retainedOfflineStock","shortpick"],"title":"FacilityStockConfiguration","type":"object","description":"FacilityStockConfiguration"},"FacilityStockConfigurationListingReactivationAfter":{"properties":{"active":{"default":true,"description":"The disabling of listings is enabled or disabled.","type":"boolean"},"value":{"default":24,"description":"Time in hours that has to pass for a deactivated listing (e.g. due to manual deactivation or as a result of a shortpick) to become active again.","type":"number"}},"title":"FacilityStockConfigurationListingReactivationAfter","type":"object","description":"FacilityStockConfigurationListingReactivationAfter"},"FacilityStockConfigurationRetainedOfflineStock":{"properties":{"active":{"deprecated":true,"description":"The retained Offline Stock is enabled or disabled.","type":"boolean"},"value":{"default":0.2,"deprecated":true,"description":"The overall percentage of stock that should be reserved to offline clients.","maximum":1,"minimum":0.01,"type":"number"}},"title":"FacilityStockConfigurationRetainedOfflineStock","type":"object","description":"FacilityStockConfigurationRetainedOfflineStock"},"FacilityStockConfigurationShortpick":{"properties":{"active":{"default":true,"description":"Inventory adjustment in the case of insufficient order picking","type":"boolean"}},"required":["active"],"title":"FacilityStockConfigurationShortpick","type":"object","description":"FacilityStockConfigurationShortpick"}}}}
```

## The FacilityStockConfigurationListingReactivationAfter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStockConfigurationListingReactivationAfter":{"properties":{"active":{"default":true,"description":"The disabling of listings is enabled or disabled.","type":"boolean"},"value":{"default":24,"description":"Time in hours that has to pass for a deactivated listing (e.g. due to manual deactivation or as a result of a shortpick) to become active again.","type":"number"}},"title":"FacilityStockConfigurationListingReactivationAfter","type":"object","description":"FacilityStockConfigurationListingReactivationAfter"}}}}
```

## The FacilityStockConfigurationRetainedOfflineStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStockConfigurationRetainedOfflineStock":{"properties":{"active":{"deprecated":true,"description":"The retained Offline Stock is enabled or disabled.","type":"boolean"},"value":{"default":0.2,"deprecated":true,"description":"The overall percentage of stock that should be reserved to offline clients.","maximum":1,"minimum":0.01,"type":"number"}},"title":"FacilityStockConfigurationRetainedOfflineStock","type":"object","description":"FacilityStockConfigurationRetainedOfflineStock"}}}}
```

## The FacilityStockConfigurationShortpick object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStockConfigurationShortpick":{"properties":{"active":{"default":true,"description":"Inventory adjustment in the case of insufficient order picking","type":"boolean"}},"required":["active"],"title":"FacilityStockConfigurationShortpick","type":"object","description":"FacilityStockConfigurationShortpick"}}}}
```

## The FacilityStockDistribution object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityStockDistribution":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","minimum":0,"type":"number"},"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/ByTrait"},"channelAdjusted":{"items":{"$ref":"#/components/schemas/ChannelStockAvailability"},"type":"array"},"facilityId":{"type":"string"},"facilityName":{"type":"string"},"facilityServiceTypes":{"items":{"$ref":"#/components/schemas/FacilityServiceType"},"type":"array"},"facilityStatus":{"$ref":"#/components/schemas/FacilityStatus"},"price":{"deprecated":true,"description":"Use listings attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","nullable":true,"type":"number"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"minimum":0,"type":"number"},"safetyStock":{"minimum":0,"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"minimum":0,"type":"number"}},"required":["reserved","totalAmount","available","safetyStock","byTrait","availableForPicking","availableToPromise","readyToPick","availableOnStock","stockOnHand","facilityId","facilityName"],"title":"FacilityStockDistribution","type":"object","description":"FacilityStockDistribution"},"ByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"ByTrait","type":"object","description":"ByTrait"},"ChannelStockAvailability":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"channelRef":{"type":"string"}},"required":["channelRef","availableForPicking","availableOnStock"],"title":"ChannelStockAvailability","type":"object","description":"ChannelStockAvailability"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"}}}}
```

## The FacilitySuspendedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilitySuspendedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ManagedFacility"}},"required":["payload"],"type":"object","title":"FacilitySuspendedWebHookEvent","description":"FacilitySuspendedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"}}}}
```

## The FacilityTagsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityTagsFilter","type":"object","description":"FacilityTagsFilter"},"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"}}}}
```

## The FacilityTagsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityTagsListFilter","type":"object","description":"FacilityTagsListFilter"},"FacilityTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityTagsFilter","type":"object","description":"FacilityTagsFilter"},"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"}}}}
```

## The FacilityType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"}}}}
```

## The FacilityTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"}},"title":"FacilityTypeEnumFilter","type":"object","description":"FacilityTypeEnumFilter"}}}}
```

## The FacilityUpdatedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityUpdatedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ManagedFacility"}},"required":["payload"],"type":"object","title":"FacilityUpdatedWebHookEvent","description":"FacilityUpdatedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"}}}}
```

## The FacilityWentOfflineWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityWentOfflineWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ManagedFacility"}},"required":["payload"],"type":"object","title":"FacilityWentOfflineWebHookEvent","description":"FacilityWentOfflineWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"}}}}
```

## The FacilityWentOnlineWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityWentOnlineWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ManagedFacility"}},"required":["payload"],"type":"object","title":"FacilityWentOnlineWebHookEvent","description":"FacilityWentOnlineWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"}}}}
```

## The FallbackFacilityConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FallbackFacilityConfiguration":{"deprecated":true,"description":"@deprecated use RoutingStrategyFallbackFacilityConfiguration instead","properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"FallbackFacilityConfiguration"}}}}
```

## The FallbackFacilityConfigurationForPatch object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FallbackFacilityConfigurationForPatch":{"deprecated":true,"description":"@deprecated use RoutingStrategyFallbackFacilityConfiguration instead","properties":{"active":{"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"title":"FallbackFacilityConfigurationForPatch"}}}}
```

## The Feature object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Feature":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"name":{"type":"string"},"status":{"$ref":"#/components/schemas/FeatureStatus"}},"required":["name","status"],"type":"object","title":"Feature","description":"Feature"},"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"},"FeatureStatus":{"enum":["enabled","inactive","disabled"],"type":"string","title":"FeatureStatus","description":"FeatureStatus"}}}}
```

## The FeaturePatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FeaturePatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyFeature"},"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":"FeaturePatchActions"},"title":"FeaturePatchActions","description":"FeaturePatchActions"},"ModifyFeature":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyFeature', because you want to modify a Feature","enum":["ModifyFeature"],"type":"string"},"status":{"$ref":"#/components/schemas/FeatureStatus","description":"The state of the feature we want to change."}},"required":["action","status"],"type":"object"}],"xml":{"name":"ModifyFeature"},"title":"ModifyFeature","description":"ModifyFeature"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"FeatureStatus":{"enum":["enabled","inactive","disabled"],"type":"string","title":"FeatureStatus","description":"FeatureStatus"}}}}
```

## The FeatureStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FeatureStatus":{"enum":["enabled","inactive","disabled"],"type":"string","title":"FeatureStatus","description":"FeatureStatus"}}}}
```

## The FedexCarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FedexCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultCommodityDescription":{"description":"Default commodity description","type":"string"},"defaultManufactureCountry":{"description":"Default manufacture country","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"defaultPriceCurrency":{"description":"Default price currency for shipments","type":"string"},"defaultPriceValue":{"description":"Default price value for shipments","type":"number"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"useEconomyService":{"description":"Whether to use the economy service","type":"boolean"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel","useEconomyService","defaultPriceValue","defaultPriceCurrency","defaultManufactureCountry","defaultCommodityDescription"],"title":"FedexCarrierConfiguration","type":"object","description":"FedexCarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The Fence object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Fence":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"id":{"description":"This value identifies this very instance of the fence. It is set autmatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"}},"required":["active","implementation","id"],"type":"object","title":"Fence","description":"Fence"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"}}}}
```

## The FenceAnalysis object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FenceAnalysis":{"properties":{"fenceId":{"description":"The ID of the fence.","type":"string"},"fenceName":{"description":"The name of the fence.","type":"string"},"fenceType":{"description":"The type of fence.","enum":["STANDARD","TOOLKIT"],"type":"string"},"layer":{"description":"The layer at which the fence was evaluated.","type":"number"},"listingId":{"description":"The ID of the listing.","type":"string"},"nodeId":{"description":"The ID of the node.","type":"string"},"result":{"description":"The result of the fence evaluation.","enum":["PASSED","FAILED","NOT_APPLICABLE"],"type":"string"}},"required":["fenceType","nodeId","fenceId","result"],"title":"FenceAnalysis","type":"object","description":"FenceAnalysis"}}}}
```

## The FenceImplementation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"}}}}
```

## The FenceMode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"}}}}
```

## The FenceResultStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FenceResultStatus":{"enum":["FAILED","PASSED","REACTIVE_PASSING_POSSIBLE"],"title":"FenceResultStatus","description":"FenceResultStatus"}}}}
```

## The FenceStatistic object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FenceStatistic":{"properties":{"durationMs":{"description":"Duration in Milliseconds","type":"number"},"name":{"type":"string"},"passedAmount":{"type":"number"},"passedPercentage":{"type":"number"},"rejectedAmount":{"type":"number"}},"required":["name","rejectedAmount","passedAmount","passedPercentage","durationMs"],"title":"FenceStatistic","description":"FenceStatistic"}}}}
```

## The FFTActivityNode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FFTActivityNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node - module nodes that map to business entities","enum":["ORDER_MODULE","PICKING_MODULE","PACKING_MODULE","HANDOVER_MODULE","RESERVATION_MODULE","ROUTING_MODULE","SHIPPING_MODULE","SERVICES_MODULE"],"type":"string"}},"required":["key","type"],"title":"FFTActivityNode","type":"object","description":"FFTActivityNode"},"WorkflowNameLocaleString":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowNameLocaleString","type":"object"},"WorkflowDescriptionLocaleString":{"additionalProperties":{"maxLength":500,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowDescriptionLocaleString","type":"object"}}}}
```

## The FilterEntity object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FilterEntity":{"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupportedFilterEntityTypesEnum"},"value":{"type":"string"}},"required":["valueLocalized","id","type"],"type":"object","xml":{"name":"FilterEntity"},"title":"FilterEntity","description":"FilterEntity"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SupportedFilterEntityTypesEnum":{"description":"Entity types supported as filter entities","enum":["STICKER"],"type":"string","title":"SupportedFilterEntityTypesEnum"}}}}
```

## The FinishHandoverJobActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FinishHandoverJobActionEnum":{"enum":["FINISH_HANDOVER_JOB"],"type":"string","title":"FinishHandoverJobActionEnum","description":"FinishHandoverJobActionEnum"}}}}
```

## The FinishHandoverJobActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The FinishHandoverJobLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The FinishHandoverJobSubstituteLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The FinishItemReturnActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FinishItemReturnActionParameter":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"enum":["FinishItemReturn"],"type":"string"}},"required":["name","itemReturnJobVersion"],"title":"FinishItemReturnActionParameter","type":"object","description":"FinishItemReturnActionParameter"}}}}
```

## The FinishItemReturnJobActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FinishItemReturnJobActionParameter":{"properties":{"name":{"enum":["FinishItemReturnJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","name"],"title":"FinishItemReturnJobActionParameter","type":"object","description":"FinishItemReturnJobActionParameter"}}}}
```

## The FinishPickRun object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FinishPickRun":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'FinishPickRun', because you want to finish a pickrun","enum":["FinishPickRun"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickruns/:id/actions instead","title":"FinishPickRun","xml":{"name":"FinishPickRun"}}}}}
```

## The FixedCountConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FixedCountConfiguration":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration of fixed count split.","properties":{"maxSplitCount":{"description":"This setting defines how often an order split might be performed to fulfill the order.","minimum":1,"type":"number"}},"required":["maxSplitCount"],"type":"object","title":"FixedCountConfiguration"}}}}
```

## The FloatValidation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FloatValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as float.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"FloatValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"}}}}
```

## The FulfillmentProcessBufferConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FulfillmentProcessBufferConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"},"minutes":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"}},"required":["minutes"],"type":"object","title":"FulfillmentProcessBufferConfiguration","description":"FulfillmentProcessBufferConfiguration"},"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"}}}}
```

## The GdprConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GdprConfiguration":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"actorAnonymization":{"default":true,"description":"If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect","type":"boolean"},"deletionTimeAfterRetention":{"description":"Number of days since anonymization until deletion is triggered","minimum":1,"type":"number"},"id":{"type":"string"},"retentionTime":{"description":"Number of days after that anonymization is triggered.","minimum":1,"type":"number"},"version":{"format":"int64","type":"integer"}},"required":["retentionTime","version"],"type":"object","title":"GdprConfiguration","description":"GdprConfiguration"},"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"}}}}
```

## The GeoFence object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GeoFence":{"description":"Center (described with lon and lat attributes) and a circular geofence (described as radius around the center)","properties":{"lat":{"description":"The latitude of the center, provided as decimal coordinate","type":"number"},"lon":{"description":"The longitude of the center, provided as decimal coordinate","type":"number"},"radius":{"description":"Radius around the center in kilometers (km, max. 100)","minimum":1,"type":"number"}},"required":["lat","lon","radius"],"type":"object","title":"GeoFence"}}}}
```

## The GetParcelInformationListParams object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GetParcelInformationListParams":{"properties":{"facilityRefs":{"description":"filter by facilityRefs","items":{"type":"string"},"maxItems":50,"type":"array"},"orderBy":{"description":"the value by which results should be ordered by. If nothing is passed return values are sorted by id","type":"string"},"shippingInformationRef":{"description":"filter by shippingInformationRef","type":"string"},"size":{"default":25,"description":"number of entities to show. Max value is 500","maximum":500,"minimum":1,"type":"integer"},"startAfterId":{"description":"entity to start after","type":"string"},"withTotal":{"description":"if set to true, the total count of entities will be returned. Default is false","type":"boolean"}},"title":"GetParcelInformationListParams","type":"object","description":"GetParcelInformationListParams"}}}}
```

## The GetShippingInformationParams object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GetShippingInformationParams":{"properties":{"facilityRefs":{"description":"filter by facilityRefs","items":{"type":"string"},"maxItems":50,"type":"array"},"orderBy":{"description":"the value by which results should be ordered by. If nothing is passed return values are sorted by id","type":"string"},"size":{"default":25,"description":"number of entities to show. Max value is 500","maximum":500,"minimum":1,"type":"integer"},"startAfterId":{"description":"entity to start after","type":"string"},"tenantOrderId":{"description":"filter by tenantOrderId","type":"string"},"withTotal":{"description":"if set to true, the total count of entities found by the given search criteria will be returned. Default is false","type":"boolean"}},"title":"GetShippingInformationParams","type":"object","description":"GetShippingInformationParams"}}}}
```

## The GlobalManualRerouteConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GlobalManualRerouteConfiguration":{"description":"Allows reroutes to be triggered manually via api.","properties":{"active":{"type":"boolean"}},"required":["active"],"type":"object","title":"GlobalManualRerouteConfiguration"}}}}
```

## The GlobalRoutingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GlobalRoutingConfiguration":{"description":"Global configuration for routing","properties":{"defaultPrice":{"default":10,"description":"Default price which is used if no price exists in order or listings","type":"number"},"fallbackFacilityConfiguration":{"$ref":"#/components/schemas/FallbackFacilityConfiguration"},"manualReroute":{"$ref":"#/components/schemas/GlobalManualRerouteConfiguration"},"routingTimeout":{"default":8,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Default amount of hours after which a routing plan is marked not routable. This field is deprecated in favour of stopRoutingAttemptsAfterTime","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"Default amount of time in ISO 8601 duration format after which a routing plan is marked not routable. The duration need to be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["defaultPrice"],"type":"object","title":"GlobalRoutingConfiguration"},"FallbackFacilityConfiguration":{"deprecated":true,"description":"@deprecated use RoutingStrategyFallbackFacilityConfiguration instead","properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"FallbackFacilityConfiguration"},"GlobalManualRerouteConfiguration":{"description":"Allows reroutes to be triggered manually via api.","properties":{"active":{"type":"boolean"}},"required":["active"],"type":"object","title":"GlobalManualRerouteConfiguration"}}}}
```

## The GlsCarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GlsCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeReturnAddressLocationId":{"description":"Alternative return address location ID","type":"string"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"alternativeSendAddressLocationId":{"description":"Alternative send address location ID","type":"string"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"trackAndTraceWsdlUrl":{"description":"WSDL URL for track and trace","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"GlsCarrierConfiguration","type":"object","description":"GlsCarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The GuardWorkflowNode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GuardWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"description":"Guard condition: an expression or a built-in (preconfigured) guard.","discriminator":{"mapping":{"EXPRESSION":"#/components/schemas/ExpressionGuardCondition","PRECONFIGURED":"#/components/schemas/PreconfiguredGuardCondition"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/ExpressionGuardCondition"},{"$ref":"#/components/schemas/PreconfiguredGuardCondition"}]},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["GUARD"],"type":"string"}},"required":["key","type","condition"],"title":"GuardWorkflowNode","type":"object","description":"GuardWorkflowNode"},"WorkflowNameLocaleString":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowNameLocaleString","type":"object"},"WorkflowDescriptionLocaleString":{"additionalProperties":{"maxLength":500,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowDescriptionLocaleString","type":"object"},"ExpressionGuardCondition":{"properties":{"entity":{"description":"Entity the expression applies to","enum":["ORDER","INCOMING_EVENT"],"type":"string"},"expression":{"description":"JSONPath expression evaluated to decide the guard.","type":"string"},"kind":{"description":"Discriminator: expression-based guard.","enum":["EXPRESSION"],"type":"string"}},"required":["kind","expression","entity"],"title":"ExpressionGuardCondition","type":"object","description":"ExpressionGuardCondition"},"PreconfiguredGuardCondition":{"properties":{"kind":{"description":"Discriminator: built-in guard.","enum":["PRECONFIGURED"],"type":"string"},"preconfigured":{"description":"Which built-in guard to run","enum":["ORDER_GATE"],"type":"string"}},"required":["kind","preconfigured"],"title":"PreconfiguredGuardCondition","type":"object","description":"PreconfiguredGuardCondition"}}}}
```

## The HandledItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"}}}}
```

## The HandoverConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />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"],"type":"object","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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The HandoverConfigurationForCreate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />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":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized reason"},"active":{"type":"boolean"}},"required":["active","refusedReasonLocalized"],"type":"object","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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The HandoverContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"type":"string"},"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"type":"object"},"description":{"description":"Translated Description from descriptionLocalized","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"References to the documents that are related to this handover container.","type":"string"},"facilityRef":{"description":"Linked Facility through reference","type":"string"},"handoverJobRef":{"description":"Linked HandoverJob through reference","type":"string"},"iconUrl":{"description":"URL to icon","type":"string"},"id":{"description":"Unique identifier of the handover container","type":"string"},"identifierCode":{"description":"The identifier code generated for this container at creation time, used to render its identifier document.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/HandoverContainerLineItem"},"type":"array"},"name":{"description":"Translated name from nameLocalized","type":"string"},"operativeContainerTypeRef":{"description":"Linked Operative Container Type through reference","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"processRef":{"description":"Linked Process through reference","type":"string"},"sequenceNumber":{"format":"int32","maximum":10000,"minimum":0,"type":"integer"},"stackRef":{"description":"Linked stack through reference","type":"string"},"storageLocationRef":{"description":"Linked StorageLocation through reference","type":"string"},"type":{"description":"Type of the container. Can either be PHYSICAL or VIRTUAL.","enum":["PHYSICAL","VIRTUAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit in gram for this Container","type":"integer"}},"required":["created","lastModified","version","id","facilityRef","processRef","stackRef","lineItems","handoverJobRef","nameLocalized","type"],"title":"HandoverContainer","type":"object","description":"HandoverContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"HandoverContainerLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverContainerLineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Amount per line item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"HandoverContainerLineItem","type":"object","description":"HandoverContainerLineItem"},"HandoverContainerLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"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. Ensure that no authentication is needed 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":"HandoverContainerLineItemArticle","type":"object","description":"HandoverContainerLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The HandoverContainerForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverContainerForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"customAttributes":{"type":"object"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"handoverJobRef":{"description":"Linked HandoverJob through reference","type":"string"},"iconUrl":{"description":"URL to icon","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/HandoverContainerLineItemForCreation"},"maxItems":50,"type":"array"},"operativeContainerTypeRef":{"description":"Linked Operative Container Type through reference","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"sequenceNumber":{"format":"int32","maximum":10000,"minimum":0,"type":"integer"},"stackRef":{"description":"Linked Stack through reference","type":"string"},"storageLocationRef":{"description":"Linked StorageLocation through reference","type":"string"},"weightLimitInG":{"description":"Weight limit in gram for this Container","type":"integer"}},"required":["handoverJobRef","lineItems","nameLocalized"],"title":"HandoverContainerForCreation","type":"object","description":"HandoverContainerForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"HandoverContainerLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/HandoverContainerLineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Amount per line item","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"HandoverContainerLineItemForCreation","type":"object","description":"HandoverContainerLineItemForCreation"},"HandoverContainerLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"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. Ensure that no authentication is needed 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":"HandoverContainerLineItemArticle","type":"object","description":"HandoverContainerLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The HandoverContainerLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverContainerLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverContainerLineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Amount per line item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"HandoverContainerLineItem","type":"object","description":"HandoverContainerLineItem"},"HandoverContainerLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"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. Ensure that no authentication is needed 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":"HandoverContainerLineItemArticle","type":"object","description":"HandoverContainerLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"}}}}
```

## The HandoverContainerLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverContainerLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"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. Ensure that no authentication is needed 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":"HandoverContainerLineItemArticle","type":"object","description":"HandoverContainerLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The HandoverContainerLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverContainerLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/HandoverContainerLineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Amount per line item","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"HandoverContainerLineItemForCreation","type":"object","description":"HandoverContainerLineItemForCreation"},"HandoverContainerLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"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. Ensure that no authentication is needed 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":"HandoverContainerLineItemArticle","type":"object","description":"HandoverContainerLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The Handoverjob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"additionalHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/AdditionalHandoverJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"$ref":"#/components/schemas/HandoverjobChannel"},"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":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This field is deprecated since 30 April 2026. HandoverJobs should not be aware of load units. The relation to load units are via handover container, if there ist a relation.","items":{"type":"string"},"type":"array","deprecated":true},"missingHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/MissingHandoverJobLineItem"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"pickupIdentifier":{"description":"A short, human readable code used to identify this handoverjob when a customer collects the order at the facility, either by scanning a QR code or by typing the code into a search. It is generated automatically during creation and cannot be set or changed by clients. Consists of 10 characters from the alphabet 0123456789ABCDEFGHJKMNPQRSTVWXYZ, which omits the easily confused letters I, L, O and U. Clients may display it grouped, for example H7K29-XQRM4. The code is drawn at random from a space of 32^10 and uniqueness is not enforced, so a lookup by pickupIdentifier can in rare cases return more than one handoverjob and clients should be able to handle that.","type":"string"},"pickupServices":{"items":{"$ref":"#/components/schemas/HandoverJobPickupService"},"maxItems":100,"type":"array"},"pricing":{"$ref":"#/components/schemas/OrderPricing"},"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"},"scannableCodes":{"description":"Codes that can be used for scanning this handover job","items":{"type":"string"},"maxItems":20,"type":"array"},"shipmentRef":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"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","workflowInformation"],"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"},"AdditionalHandoverJobLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["id","article","quantity"],"title":"AdditionalHandoverJobLineItem","description":"AdditionalHandoverJobLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"HandoverjobChannel":{"enum":["DELIVERY","COLLECT"],"type":"string","title":"HandoverjobChannel","description":"HandoverjobChannel"},"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","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"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"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"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"},"maxItems":500,"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"},"MissingHandoverJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MissingHandoverJobLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"MissingHandoverJobLineItem","description":"MissingHandoverJobLineItem"},"MissingHandoverJobLineItemForCreation":{"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 is missing","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"MissingHandoverJobLineItemForCreation","description":"MissingHandoverJobLineItemForCreation"},"HandoverJobPickupService":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"applied":{"description":"indicates if the pickup service has been applied","type":"boolean"},"description":{"description":"Localized description of pickup service","type":"string"},"id":{"description":"Identifies the single HandoverJobPickupService of a HandoverJob","type":"string"},"name":{"description":"Localized name of pickup service","type":"string"},"type":{"description":"Type of the pickup service","type":"string"}},"required":["id","type","applied"],"title":"HandoverJobPickupService","description":"HandoverJobPickupService"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The HandoverJobActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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"},{"$ref":"#/components/schemas/MoveHandoverJobLineItemsActionParameter"},{"$ref":"#/components/schemas/HandoverJobAddTargetTimeActionParameter"},{"$ref":"#/components/schemas/HandoverJobModifyPickUpServicesActionParameter"},{"$ref":"#/components/schemas/HandoverJobRemoveAdditionalLineItemsActionParameter"},{"$ref":"#/components/schemas/HandoverJobAddAdditionalLineItemsActionParameter"}],"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":{"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"HandoverSubstituteLineItemForUpdate":{"properties":{"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"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"},"MoveHandoverJobLineItemsActionParameter":{"additionalProperties":false,"description":"Action to move line items of a handover job from line items array to another (expected, missing, handover)","properties":{"items":{"items":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsInfo"},"maxItems":50,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","items"],"title":"MoveHandoverJobLineItemsActionParameter"},"MoveHandoverJobLineItemsInfo":{"additionalProperties":false,"description":"Information about the line items that should be moved from one array to another","properties":{"from":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsArrayTypeEnum"},"lineItemId":{"description":"References the id of the line item of a handover job. Can be the id of a expectedHandoverJobLineItem, handoverLineItem or missingHandoverJobLineItem","type":"string"},"targetQuantity":{"description":"The quantity of the line item that should be moved.","minimum":1,"type":"integer"},"to":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsArrayTypeEnum"}},"required":["lineItemId","from","to","targetQuantity"],"title":"MoveHandoverJobLineItemsInfo"},"MoveHandoverJobLineItemsArrayTypeEnum":{"enum":["EXPECTED","HANDOVER","MISSING"],"type":"string","title":"MoveHandoverJobLineItemsArrayTypeEnum","description":"MoveHandoverJobLineItemsArrayTypeEnum"},"MoveHandoverJobLineItemsActionEnum":{"enum":["MOVE_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"MoveHandoverJobLineItemsActionEnum","description":"MoveHandoverJobLineItemsActionEnum"},"HandoverJobAddTargetTimeActionParameter":{"additionalProperties":false,"description":"Action to add targetTime to a HandoverJob that has none. Will fail if targetTime is already set","properties":{"name":{"$ref":"#/components/schemas/HandoverJobAddTargetTimeActionEnum"},"targetTime":{"description":"The target time you want set for the given handoverJob.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"HandoverJobAddTargetTimeActionParameter","type":"object"},"HandoverJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"HandoverJobAddTargetTimeActionEnum","description":"HandoverJobAddTargetTimeActionEnum"},"HandoverJobModifyPickUpServicesActionParameter":{"additionalProperties":false,"description":"Action to update handoverJobs pickup services","properties":{"name":{"$ref":"#/components/schemas/HandoverJobModifyPickUpServicesActionEnum"},"pickUpServiceUpdates":{"items":{"$ref":"#/components/schemas/PickUpServiceUpdate"},"maxItems":100,"type":"array"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","pickUpServiceUpdates"],"title":"HandoverJobModifyPickUpServicesActionParameter","type":"object"},"HandoverJobModifyPickUpServicesActionEnum":{"enum":["MODIFY_PICKUP_SERVICES"],"type":"string","title":"HandoverJobModifyPickUpServicesActionEnum","description":"HandoverJobModifyPickUpServicesActionEnum"},"PickUpServiceUpdate":{"additionalProperties":false,"properties":{"applied":{"description":"indicates if pickup service has been applied","type":"boolean"},"id":{"description":"id of the HandoverJobPickupServices you want to update","type":"string"}},"required":["id","applied"],"type":"object","title":"PickUpServiceUpdate","description":"PickUpServiceUpdate"},"HandoverJobRemoveAdditionalLineItemsActionParameter":{"additionalProperties":false,"description":"Action to remove line items from additionalHandoverJobLineItems","properties":{"lineItemIds":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/HandoverJobRemoveAdditionalLineItemsActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","lineItemIds"],"title":"HandoverJobRemoveAdditionalLineItemsActionParameter","type":"object"},"HandoverJobRemoveAdditionalLineItemsActionEnum":{"enum":["REMOVE_ADDITIONAL_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"HandoverJobRemoveAdditionalLineItemsActionEnum","description":"HandoverJobRemoveAdditionalLineItemsActionEnum"},"HandoverJobAddAdditionalLineItemsActionParameter":{"additionalProperties":false,"description":"Action to add line items to additionalHandoverJobLineItems","properties":{"items":{"items":{"$ref":"#/components/schemas/AdditionalHandoverJobLineItemForCreation"},"maxItems":100,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/HandoverJobAddAdditionalLineItemsActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","items"],"title":"HandoverJobAddAdditionalLineItemsActionParameter","type":"object"},"AdditionalHandoverJobLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["article","quantity"],"title":"AdditionalHandoverJobLineItemForCreation","description":"AdditionalHandoverJobLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"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. Ensure that no authentication is needed 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"},"HandoverJobAddAdditionalLineItemsActionEnum":{"enum":["ADD_ADDITIONAL_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"HandoverJobAddAdditionalLineItemsActionEnum","description":"HandoverJobAddAdditionalLineItemsActionEnum"}}}}
```

## The HandoverJobAddAdditionalLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobAddAdditionalLineItemsActionEnum":{"enum":["ADD_ADDITIONAL_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"HandoverJobAddAdditionalLineItemsActionEnum","description":"HandoverJobAddAdditionalLineItemsActionEnum"}}}}
```

## The HandoverJobAddAdditionalLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobAddAdditionalLineItemsActionParameter":{"additionalProperties":false,"description":"Action to add line items to additionalHandoverJobLineItems","properties":{"items":{"items":{"$ref":"#/components/schemas/AdditionalHandoverJobLineItemForCreation"},"maxItems":100,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/HandoverJobAddAdditionalLineItemsActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","items"],"title":"HandoverJobAddAdditionalLineItemsActionParameter","type":"object"},"AdditionalHandoverJobLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["article","quantity"],"title":"AdditionalHandoverJobLineItemForCreation","description":"AdditionalHandoverJobLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"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. Ensure that no authentication is needed 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"},"HandoverJobAddAdditionalLineItemsActionEnum":{"enum":["ADD_ADDITIONAL_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"HandoverJobAddAdditionalLineItemsActionEnum","description":"HandoverJobAddAdditionalLineItemsActionEnum"}}}}
```

## The HandoverJobAdditionalHandoverJobLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobAdditionalHandoverJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter"},"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"}}}}
```

## The HandoverJobAdditionalHandoverJobLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobAdditionalHandoverJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsArticleFilter"}],"description":"Nested search by article"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"}},"title":"HandoverJobAdditionalHandoverJobLineItemsFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsFilter"},"HandoverJobAdditionalHandoverJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The HandoverJobAdditionalHandoverJobLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobAdditionalHandoverJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"HandoverJobAdditionalHandoverJobLineItemsListFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsListFilter"},"HandoverJobAdditionalHandoverJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsArticleFilter"}],"description":"Nested search by article"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"}},"title":"HandoverJobAdditionalHandoverJobLineItemsFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsFilter"},"HandoverJobAdditionalHandoverJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The HandoverJobAddTargetTimeActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"HandoverJobAddTargetTimeActionEnum","description":"HandoverJobAddTargetTimeActionEnum"}}}}
```

## The HandoverJobAddTargetTimeActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobAddTargetTimeActionParameter":{"additionalProperties":false,"description":"Action to add targetTime to a HandoverJob that has none. Will fail if targetTime is already set","properties":{"name":{"$ref":"#/components/schemas/HandoverJobAddTargetTimeActionEnum"},"targetTime":{"description":"The target time you want set for the given handoverJob.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"HandoverJobAddTargetTimeActionParameter","type":"object"},"HandoverJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"HandoverJobAddTargetTimeActionEnum","description":"HandoverJobAddTargetTimeActionEnum"}}}}
```

## The HandoverJobAssignedUsersFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverJobAssignedUsersListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobAssignedUsersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAssignedUsersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"}}}}
```

## The HandoverJobCancelActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"HandoverJobCancelActionEnum","description":"HandoverJobCancelActionEnum"}}}}
```

## The HandoverJobCancelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverJobCancelReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"}}}}
```

## The HandoverjobChannel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverjobChannel":{"enum":["DELIVERY","COLLECT"],"type":"string","title":"HandoverjobChannel","description":"HandoverjobChannel"}}}}
```

## The HandoverJobChannelEnumEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverjobForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"$ref":"#/components/schemas/HandoverjobChannel"},"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":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This field is deprecated since 30 April 2026. HandoverJobs should not be aware of load units. The relation to load units are via handover container, if there ist a relation.","items":{"type":"string"},"type":"array","deprecated":true},"missingHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/MissingHandoverJobLineItemForCreation"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"scannableCodes":{"description":"Codes that can be used for scanning this handoverjob","items":{"type":"string"},"maxItems":20,"type":"array"},"shipmentRef":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"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"},"HandoverjobChannel":{"enum":["DELIVERY","COLLECT"],"type":"string","title":"HandoverjobChannel","description":"HandoverjobChannel"},"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"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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":{"allOf":[{"$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"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","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":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"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"},"maxItems":500,"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"},"MissingHandoverJobLineItemForCreation":{"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 is missing","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"MissingHandoverJobLineItemForCreation","description":"MissingHandoverJobLineItemForCreation"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The HandoverJobHandoverJobLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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"}}}}
```

## The HandoverJobHandoverJobLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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"},"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"}}}}
```

## The HandoverJobHandoverJobLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobHandoverJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"},"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"},"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"}}}}
```

## The HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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"}}}}
```

## The HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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"}}}}
```

## The HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"},"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"}}}}
```

## The HandoverJobHandoverJobParcelInfoFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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"}}}}
```

## The HandoverJobHandoverjobStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverJobInvoiceAddressFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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"}}}}
```

## The HandoverJobLineItemUpdateActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobLineItemUpdateActionEnum":{"enum":["UPDATE_LINEITEM"],"type":"string","title":"HandoverJobLineItemUpdateActionEnum","description":"HandoverJobLineItemUpdateActionEnum"}}}}
```

## The HandoverJobLineItemUpdateActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobLineItemUpdateActionParameter":{"additionalProperties":false,"description":"Action to update a lineItem of a handoverjob.","properties":{"lineItem":{"additionalProperties":false,"properties":{"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"HandoverSubstituteLineItemForUpdate":{"properties":{"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"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"}}}}
```

## The HandoverJobLogCancellationPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobLogCancellationPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"}},"type":"object","title":"HandoverJobLogCancellationPayload","description":"HandoverJobLogCancellationPayload"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"}}}}
```

## The HandoverJobModifyPickUpServicesActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobModifyPickUpServicesActionEnum":{"enum":["MODIFY_PICKUP_SERVICES"],"type":"string","title":"HandoverJobModifyPickUpServicesActionEnum","description":"HandoverJobModifyPickUpServicesActionEnum"}}}}
```

## The HandoverJobModifyPickUpServicesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobModifyPickUpServicesActionParameter":{"additionalProperties":false,"description":"Action to update handoverJobs pickup services","properties":{"name":{"$ref":"#/components/schemas/HandoverJobModifyPickUpServicesActionEnum"},"pickUpServiceUpdates":{"items":{"$ref":"#/components/schemas/PickUpServiceUpdate"},"maxItems":100,"type":"array"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","pickUpServiceUpdates"],"title":"HandoverJobModifyPickUpServicesActionParameter","type":"object"},"HandoverJobModifyPickUpServicesActionEnum":{"enum":["MODIFY_PICKUP_SERVICES"],"type":"string","title":"HandoverJobModifyPickUpServicesActionEnum","description":"HandoverJobModifyPickUpServicesActionEnum"},"PickUpServiceUpdate":{"additionalProperties":false,"properties":{"applied":{"description":"indicates if pickup service has been applied","type":"boolean"},"id":{"description":"id of the HandoverJobPickupServices you want to update","type":"string"}},"required":["id","applied"],"type":"object","title":"PickUpServiceUpdate","description":"PickUpServiceUpdate"}}}}
```

## The HandoverJobOrderBy object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobOrderBy":{"description":"STATUS_TARGET_TIME_LAST_MODIFIED_DATE is deprecated","enum":["STATUS_TARGET_TIME_LAST_MODIFIED_DATE","TARGET_TIME_ASC"],"title":"HandoverJobOrderBy"}}}}
```

## The HandoverJobPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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":{"additionalHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/AdditionalHandoverJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"$ref":"#/components/schemas/HandoverjobChannel"},"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":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This field is deprecated since 30 April 2026. HandoverJobs should not be aware of load units. The relation to load units are via handover container, if there ist a relation.","items":{"type":"string"},"type":"array","deprecated":true},"missingHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/MissingHandoverJobLineItem"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"pickupIdentifier":{"description":"A short, human readable code used to identify this handoverjob when a customer collects the order at the facility, either by scanning a QR code or by typing the code into a search. It is generated automatically during creation and cannot be set or changed by clients. Consists of 10 characters from the alphabet 0123456789ABCDEFGHJKMNPQRSTVWXYZ, which omits the easily confused letters I, L, O and U. Clients may display it grouped, for example H7K29-XQRM4. The code is drawn at random from a space of 32^10 and uniqueness is not enforced, so a lookup by pickupIdentifier can in rare cases return more than one handoverjob and clients should be able to handle that.","type":"string"},"pickupServices":{"items":{"$ref":"#/components/schemas/HandoverJobPickupService"},"maxItems":100,"type":"array"},"pricing":{"$ref":"#/components/schemas/OrderPricing"},"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"},"scannableCodes":{"description":"Codes that can be used for scanning this handover job","items":{"type":"string"},"maxItems":20,"type":"array"},"shipmentRef":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"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","workflowInformation"],"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"},"AdditionalHandoverJobLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["id","article","quantity"],"title":"AdditionalHandoverJobLineItem","description":"AdditionalHandoverJobLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"HandoverjobChannel":{"enum":["DELIVERY","COLLECT"],"type":"string","title":"HandoverjobChannel","description":"HandoverjobChannel"},"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","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"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"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"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"},"maxItems":500,"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"},"MissingHandoverJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MissingHandoverJobLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"MissingHandoverJobLineItem","description":"MissingHandoverJobLineItem"},"MissingHandoverJobLineItemForCreation":{"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 is missing","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"MissingHandoverJobLineItemForCreation","description":"MissingHandoverJobLineItemForCreation"},"HandoverJobPickupService":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"applied":{"description":"indicates if the pickup service has been applied","type":"boolean"},"description":{"description":"Localized description of pickup service","type":"string"},"id":{"description":"Identifies the single HandoverJobPickupService of a HandoverJob","type":"string"},"name":{"description":"Localized name of pickup service","type":"string"},"type":{"description":"Type of the pickup service","type":"string"}},"required":["id","type","applied"],"title":"HandoverJobPickupService","description":"HandoverJobPickupService"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"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"}}}}
```

## The HandoverJobParcelInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverJobParcelInfoForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverjobPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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":{"additionalProperties":false,"description":"Action to modify a HandoverJob.","properties":{"action":{"$ref":"#/components/schemas/ModifyHandoverjobActionEnum"},"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"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"}},"required":["action"],"title":"ModifyHandoverjobAction","type":"object","xml":{"name":"ModifyHandoverjob"}},"ModifyHandoverjobActionEnum":{"enum":["ModifyHandoverjob"],"type":"string","title":"ModifyHandoverjobActionEnum","description":"ModifyHandoverjobActionEnum"},"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"},"maxItems":500,"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"},"CancelHandoverjob":{"additionalProperties":false,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/handoverjobs/:id/actions instead","properties":{"action":{"$ref":"#/components/schemas/CancelHandoverjobActionEnum"},"handoverJobCancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"}},"required":["action","handoverJobCancelReason"],"title":"CancelHandoverjob","type":"object","xml":{"name":"CancelHandoverjob"}},"CancelHandoverjobActionEnum":{"enum":["CancelHandoverjob"],"type":"string","title":"CancelHandoverjobActionEnum","description":"CancelHandoverjobActionEnum"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"}}}}
```

## The HandoverJobPickupService object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobPickupService":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"applied":{"description":"indicates if the pickup service has been applied","type":"boolean"},"description":{"description":"Localized description of pickup service","type":"string"},"id":{"description":"Identifies the single HandoverJobPickupService of a HandoverJob","type":"string"},"name":{"description":"Localized name of pickup service","type":"string"},"type":{"description":"Type of the pickup service","type":"string"}},"required":["id","type","applied"],"title":"HandoverJobPickupService","description":"HandoverJobPickupService"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The HandoverJobRecipientAddressFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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"}}}}
```

## The HandoverJobRemoveAdditionalLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobRemoveAdditionalLineItemsActionEnum":{"enum":["REMOVE_ADDITIONAL_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"HandoverJobRemoveAdditionalLineItemsActionEnum","description":"HandoverJobRemoveAdditionalLineItemsActionEnum"}}}}
```

## The HandoverJobRemoveAdditionalLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobRemoveAdditionalLineItemsActionParameter":{"additionalProperties":false,"description":"Action to remove line items from additionalHandoverJobLineItems","properties":{"lineItemIds":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/HandoverJobRemoveAdditionalLineItemsActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","lineItemIds"],"title":"HandoverJobRemoveAdditionalLineItemsActionParameter","type":"object"},"HandoverJobRemoveAdditionalLineItemsActionEnum":{"enum":["REMOVE_ADDITIONAL_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"HandoverJobRemoveAdditionalLineItemsActionEnum","description":"HandoverJobRemoveAdditionalLineItemsActionEnum"}}}}
```

## The HandoverJobReplaceAssignedUsersActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"HandoverJobReplaceAssignedUsersActionEnum","description":"HandoverJobReplaceAssignedUsersActionEnum"}}}}
```

## The HandoverJobReplaceAssignedUsersActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverJobSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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":{"additionalHandoverJobLineItems":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsListFilter"}],"description":"Nested list search by additionalHandoverJobLineItems"},"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"},"pickupIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by pickupIdentifier"},"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"},"HandoverJobAdditionalHandoverJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"HandoverJobAdditionalHandoverJobLineItemsListFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsListFilter"},"HandoverJobAdditionalHandoverJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsArticleFilter"}],"description":"Nested search by article"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"}},"title":"HandoverJobAdditionalHandoverJobLineItemsFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsFilter"},"HandoverJobAdditionalHandoverJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"},"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"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"},"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"}}}}
```

## The HandoverJobSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobSearchQuery":{"properties":{"additionalHandoverJobLineItems":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsListFilter"}],"description":"Nested list search by additionalHandoverJobLineItems"},"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"},"pickupIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by pickupIdentifier"},"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"},"HandoverJobAdditionalHandoverJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"HandoverJobAdditionalHandoverJobLineItemsListFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsListFilter"},"HandoverJobAdditionalHandoverJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsArticleFilter"}],"description":"Nested search by article"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"}},"title":"HandoverJobAdditionalHandoverJobLineItemsFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsFilter"},"HandoverJobAdditionalHandoverJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"},"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"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"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"},"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"}}}}
```

## The HandoverjobSignatureForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverjobSignatureForCreation":{"additionalProperties":false,"properties":{"signatureImage":{"$ref":"#/components/schemas/HandoverjobSignatureImage"}},"type":"object","title":"HandoverjobSignatureForCreation","description":"HandoverjobSignatureForCreation"},"HandoverjobSignatureImage":{"additionalProperties":false,"description":"The signature image (PNG, JPG/JPEG, or single-page PDF) to draw into the signature rectangle of the generated signature pdf.","properties":{"content":{"description":"File content base64 encoded","type":"string"},"type":{"description":"File type of the base64 encoded content.","enum":["PNG","JPG","JPEG","PDF"],"type":"string"}},"required":["content","type"],"type":"object","title":"HandoverjobSignatureImage"}}}}
```

## The HandoverjobSignatureImage object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverjobSignatureImage":{"additionalProperties":false,"description":"The signature image (PNG, JPG/JPEG, or single-page PDF) to draw into the signature rectangle of the generated signature pdf.","properties":{"content":{"description":"File content base64 encoded","type":"string"},"type":{"description":"File type of the base64 encoded content.","enum":["PNG","JPG","JPEG","PDF"],"type":"string"}},"required":["content","type"],"type":"object","title":"HandoverjobSignatureImage"}}}}
```

## The HandoverJobSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobSort":{"properties":{"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"HandoverJobSort","type":"object","description":"HandoverJobSort"}}}}
```

## The HandoverJobSplitLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_HANDOVER_JOB"],"type":"string","title":"HandoverJobSplitLineItemsActionEnum","description":"HandoverJobSplitLineItemsActionEnum"}}}}
```

## The HandoverJobSplitLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverJobSplitLineItemsInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverjobStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The HandoverJobTagConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"title":"HandoverJobTagConfiguration","description":"HandoverJobTagConfiguration"},"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"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The HandoverJobWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverJobWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Handoverjob"}},"required":["payload"],"type":"object","title":"HandoverJobWebHookEvent","description":"HandoverJobWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"additionalHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/AdditionalHandoverJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"$ref":"#/components/schemas/HandoverjobChannel"},"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":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This field is deprecated since 30 April 2026. HandoverJobs should not be aware of load units. The relation to load units are via handover container, if there ist a relation.","items":{"type":"string"},"type":"array","deprecated":true},"missingHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/MissingHandoverJobLineItem"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"pickupIdentifier":{"description":"A short, human readable code used to identify this handoverjob when a customer collects the order at the facility, either by scanning a QR code or by typing the code into a search. It is generated automatically during creation and cannot be set or changed by clients. Consists of 10 characters from the alphabet 0123456789ABCDEFGHJKMNPQRSTVWXYZ, which omits the easily confused letters I, L, O and U. Clients may display it grouped, for example H7K29-XQRM4. The code is drawn at random from a space of 32^10 and uniqueness is not enforced, so a lookup by pickupIdentifier can in rare cases return more than one handoverjob and clients should be able to handle that.","type":"string"},"pickupServices":{"items":{"$ref":"#/components/schemas/HandoverJobPickupService"},"maxItems":100,"type":"array"},"pricing":{"$ref":"#/components/schemas/OrderPricing"},"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"},"scannableCodes":{"description":"Codes that can be used for scanning this handover job","items":{"type":"string"},"maxItems":20,"type":"array"},"shipmentRef":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"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","workflowInformation"],"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"},"AdditionalHandoverJobLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["id","article","quantity"],"title":"AdditionalHandoverJobLineItem","description":"AdditionalHandoverJobLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"HandoverjobChannel":{"enum":["DELIVERY","COLLECT"],"type":"string","title":"HandoverjobChannel","description":"HandoverjobChannel"},"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","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"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"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"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"},"maxItems":500,"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"},"MissingHandoverJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MissingHandoverJobLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"MissingHandoverJobLineItem","description":"MissingHandoverJobLineItem"},"MissingHandoverJobLineItemForCreation":{"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 is missing","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"MissingHandoverJobLineItemForCreation","description":"MissingHandoverJobLineItemForCreation"},"HandoverJobPickupService":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"applied":{"description":"indicates if the pickup service has been applied","type":"boolean"},"description":{"description":"Localized description of pickup service","type":"string"},"id":{"description":"Identifies the single HandoverJobPickupService of a HandoverJob","type":"string"},"name":{"description":"Localized name of pickup service","type":"string"},"type":{"description":"Type of the pickup service","type":"string"}},"required":["id","type","applied"],"title":"HandoverJobPickupService","description":"HandoverJobPickupService"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The HandoverLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","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":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"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. Ensure that no authentication is needed 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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The HandoverLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The HandoverLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","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":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"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. Ensure that no authentication is needed 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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The HandoverLineItemStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"}}}}
```

## The HandoverSubstituteLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"}}}}
```

## The HandoverSubstituteLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"}}}}
```

## The HandoverSubstituteLineItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HandoverSubstituteLineItemForUpdate":{"properties":{"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItemForUpdate"},"type":"array"}},"required":["id"],"title":"HandoverSubstituteLineItemForUpdate","description":"HandoverSubstituteLineItemForUpdate"},"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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The HealthDependencyStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HealthDependencyStatus":{"properties":{"name":{"description":"Name of the component that is checked to be healthy","type":"string"},"status":{"$ref":"#/components/schemas/HealthStatus"}},"required":["name","status"],"type":"object","title":"HealthDependencyStatus","description":"HealthDependencyStatus"},"HealthStatus":{"enum":["UP","DOWN"],"type":"string","title":"HealthStatus","description":"HealthStatus"}}}}
```

## The HealthResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HealthResult":{"properties":{"dependencies":{"items":{"$ref":"#/components/schemas/HealthDependencyStatus"},"minItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/HealthStatus"}},"required":["status","dependencies"],"type":"object","title":"HealthResult","description":"HealthResult"},"HealthDependencyStatus":{"properties":{"name":{"description":"Name of the component that is checked to be healthy","type":"string"},"status":{"$ref":"#/components/schemas/HealthStatus"}},"required":["name","status"],"type":"object","title":"HealthDependencyStatus","description":"HealthDependencyStatus"},"HealthStatus":{"enum":["UP","DOWN"],"type":"string","title":"HealthStatus","description":"HealthStatus"}}}}
```

## The HealthStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"HealthStatus":{"enum":["UP","DOWN"],"type":"string","title":"HealthStatus","description":"HealthStatus"}}}}
```

## The InboundAttachment object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundAttachment":{"properties":{"created":{"format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["id","version"],"title":"InboundAttachment","type":"object","description":"InboundAttachment"}}}}
```

## The InboundAttachmentForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundAttachmentForCreation":{"properties":{"content":{"description":"Base64 encoded attachment file","type":"string"},"fileName":{"description":"File name of attachment","type":"string"}},"required":["fileName","content"],"title":"InboundAttachmentForCreation","type":"object","description":"InboundAttachmentForCreation"}}}}
```

## The InboundAttachmentLink object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"}}}}
```

## The InboundDeliveryFinishedPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliveryFinishedPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold","receipts"],"title":"InboundDeliveryFinishedPayload","type":"object","description":"InboundDeliveryFinishedPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"}}}}
```

## The InboundDeliveryFinishedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliveryFinishedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/InboundDeliveryFinishedPayload"}},"required":["payload"],"type":"object","title":"InboundDeliveryFinishedWebHookEvent","description":"InboundDeliveryFinishedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"InboundDeliveryFinishedPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold","receipts"],"title":"InboundDeliveryFinishedPayload","type":"object","description":"InboundDeliveryFinishedPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"}}}}
```

## The InboundDeliveryOnHoldPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliveryOnHoldPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold"],"title":"InboundDeliveryOnHoldPayload","type":"object","description":"InboundDeliveryOnHoldPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"}}}}
```

## The InboundDeliveryOnHoldWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliveryOnHoldWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/InboundDeliveryOnHoldPayload"}},"required":["payload"],"type":"object","title":"InboundDeliveryOnHoldWebHookEvent","description":"InboundDeliveryOnHoldWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"InboundDeliveryOnHoldPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold"],"title":"InboundDeliveryOnHoldPayload","type":"object","description":"InboundDeliveryOnHoldPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"}}}}
```

## The InboundDeliveryReceivedPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliveryReceivedPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipt":{"$ref":"#/components/schemas/InboundReceipt"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold","receipt"],"title":"InboundDeliveryReceivedPayload","type":"object","description":"InboundDeliveryReceivedPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"}}}}
```

## The InboundDeliveryReceivedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliveryReceivedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/InboundDeliveryReceivedPayload"}},"required":["payload"],"type":"object","title":"InboundDeliveryReceivedWebHookEvent","description":"InboundDeliveryReceivedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"InboundDeliveryReceivedPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipt":{"$ref":"#/components/schemas/InboundReceipt"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold","receipt"],"title":"InboundDeliveryReceivedPayload","type":"object","description":"InboundDeliveryReceivedPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"}}}}
```

## The InboundDeliveryReleasedPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliveryReleasedPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold"],"title":"InboundDeliveryReleasedPayload","type":"object","description":"InboundDeliveryReleasedPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"}}}}
```

## The InboundDeliveryReleasedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliveryReleasedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/InboundDeliveryReleasedPayload"}},"required":["payload"],"type":"object","title":"InboundDeliveryReleasedWebHookEvent","description":"InboundDeliveryReleasedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"InboundDeliveryReleasedPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold"],"title":"InboundDeliveryReleasedPayload","type":"object","description":"InboundDeliveryReleasedPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"}}}}
```

## The InboundDeliverySingleReceiptPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundDeliverySingleReceiptPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipt":{"$ref":"#/components/schemas/InboundReceipt"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold","receipt"],"title":"InboundDeliverySingleReceiptPayload","type":"object","description":"InboundDeliverySingleReceiptPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"}}}}
```

## The InboundLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The InboundProcess object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcess":{"properties":{"anonymized":{"description":"Indicates the inbound process was anonymized acording to configured GDPR retention time.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundDate":{"description":"Aggregated dates from sources which advise incoming stock. Currently that is \"purchaseOrder\"","items":{"format":"date-time","type":"string"},"type":"array"},"lastModified":{"format":"date-time","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"origin":{"description":"Aggregated origin data from sources which advise incoming stock. Currently that is just  \"purchaseOrder\"","items":{"$ref":"#/components/schemas/InboundProcessOrigin"},"type":"array"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessId":{"type":"string"},"version":{"type":"number"}},"required":["facilityRef","id","version","created","lastModified","inboundDate","origin","anonymized","status","onHold","scannableCodes","receipts"],"title":"InboundProcess","type":"object","description":"InboundProcess"},"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"}}}}
```

## The InboundProcessForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessForCreation":{"properties":{"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"},"facilityRef":{"description":"Facility in which the inbound process takes place","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderForCreation"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceiptForCreation"},"maxItems":200,"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"tenantInboundProcessId":{"description":"Identifier of the process provided by the tenant system. It is recommended to be unique","type":"string"}},"required":["facilityRef"],"title":"InboundProcessForCreation","type":"object","description":"InboundProcessForCreation"},"InboundProcessPurchaseOrderForCreation":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"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"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"}},"required":["orderDate","requestedDate","requestedItems"],"title":"InboundProcessPurchaseOrderForCreation","type":"object","description":"InboundProcessPurchaseOrderForCreation"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundReceiptForCreation":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"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"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForCreation"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments"],"title":"InboundReceiptForCreation","type":"object","description":"InboundReceiptForCreation"},"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForCreation":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"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"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForCreation","type":"object","description":"InboundReceiptLineItemForCreation"}}}}
```

## The InboundProcessForPatch object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessForPatch":{"properties":{"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"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"version":{"type":"number"}},"required":["version"],"title":"InboundProcessForPatch","type":"object","description":"InboundProcessForPatch"}}}}
```

## The InboundProcessOrigin object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"}}}}
```

## The InboundProcessPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPaginatedResult":{"properties":{"inboundProcesses":{"items":{"$ref":"#/components/schemas/InboundProcess"},"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","inboundProcesses"],"title":"InboundProcessPaginatedResult","type":"object","description":"InboundProcessPaginatedResult"},"InboundProcess":{"properties":{"anonymized":{"description":"Indicates the inbound process was anonymized acording to configured GDPR retention time.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundDate":{"description":"Aggregated dates from sources which advise incoming stock. Currently that is \"purchaseOrder\"","items":{"format":"date-time","type":"string"},"type":"array"},"lastModified":{"format":"date-time","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"origin":{"description":"Aggregated origin data from sources which advise incoming stock. Currently that is just  \"purchaseOrder\"","items":{"$ref":"#/components/schemas/InboundProcessOrigin"},"type":"array"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessId":{"type":"string"},"version":{"type":"number"}},"required":["facilityRef","id","version","created","lastModified","inboundDate","origin","anonymized","status","onHold","scannableCodes","receipts"],"title":"InboundProcess","type":"object","description":"InboundProcess"},"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"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"}}}}
```

## The InboundProcessPurchaseOrder object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"}}}}
```

## The InboundProcessPurchaseOrderFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateFilter"}],"description":"Nested search by requestedDate"},"requestedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsListFilter"}],"description":"Nested list search by requestedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"}],"description":"Search by status"},"supplier":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplierFilter"}],"description":"Nested search by supplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransferFilter"}],"description":"Nested search by transfer"}},"title":"InboundProcessPurchaseOrderFilter","type":"object","description":"InboundProcessPurchaseOrderFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"},"InboundProcessPurchaseOrderRequestedDateFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"}],"description":"Search by type"},"value":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by value"}},"title":"InboundProcessPurchaseOrderRequestedDateFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateFilter"},"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["ASAP","TIME_POINT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"}},"title":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"},"InboundProcessPurchaseOrderRequestedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessPurchaseOrderRequestedItemsListFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsListFilter"},"InboundProcessPurchaseOrderRequestedItemsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessPurchaseOrderRequestedItemsFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"}},"title":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter","type":"object","description":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"},"InboundProcessPurchaseOrderSupplierFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"}},"title":"InboundProcessPurchaseOrderSupplierFilter","type":"object","description":"InboundProcessPurchaseOrderSupplierFilter"},"InboundProcessPurchaseOrderTransferFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"InboundProcessPurchaseOrderTransferFilter","type":"object","description":"InboundProcessPurchaseOrderTransferFilter"}}}}
```

## The InboundProcessPurchaseOrderForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderForCreation":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"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"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"}},"required":["orderDate","requestedDate","requestedItems"],"title":"InboundProcessPurchaseOrderForCreation","type":"object","description":"InboundProcessPurchaseOrderForCreation"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"}}}}
```

## The InboundProcessPurchaseOrderForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderForUpsert":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"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"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","version"],"title":"InboundProcessPurchaseOrderForUpsert","type":"object","description":"InboundProcessPurchaseOrderForUpsert"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"}}}}
```

## The InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"}},"title":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter","type":"object","description":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"}}}}
```

## The InboundProcessPurchaseOrderRequestedDateFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderRequestedDateFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"}],"description":"Search by type"},"value":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by value"}},"title":"InboundProcessPurchaseOrderRequestedDateFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateFilter"},"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["ASAP","TIME_POINT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"}},"title":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"},"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"}}}}
```

## The InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["ASAP","TIME_POINT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"}},"title":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"}}}}
```

## The InboundProcessPurchaseOrderRequestedItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderRequestedItemsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessPurchaseOrderRequestedItemsFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"}}}}
```

## The InboundProcessPurchaseOrderRequestedItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderRequestedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessPurchaseOrderRequestedItemsListFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsListFilter"},"InboundProcessPurchaseOrderRequestedItemsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessPurchaseOrderRequestedItemsFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"}}}}
```

## The InboundProcessPurchaseOrderSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderSort":{"properties":{"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessRequestedDateSort"}]},"supplier":{"$ref":"#/components/schemas/InboundProcessSupplierSort"}},"title":"InboundProcessPurchaseOrderSort","type":"object","description":"InboundProcessPurchaseOrderSort"},"InboundProcessRequestedDateSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessRequestedDateSort","type":"object","description":"InboundProcessRequestedDateSort"},"InboundProcessSupplierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessSupplierSort","type":"object","description":"InboundProcessSupplierSort"}}}}
```

## The InboundProcessPurchaseOrderSupplier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"}}}}
```

## The InboundProcessPurchaseOrderSupplierFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderSupplierFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"}},"title":"InboundProcessPurchaseOrderSupplierFilter","type":"object","description":"InboundProcessPurchaseOrderSupplierFilter"},"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"}}}}
```

## The InboundProcessPurchaseOrderTransfer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"}}}}
```

## The InboundProcessPurchaseOrderTransferFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessPurchaseOrderTransferFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"InboundProcessPurchaseOrderTransferFilter","type":"object","description":"InboundProcessPurchaseOrderTransferFilter"},"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"}}}}
```

## The InboundProcessReceiptBulkWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessReceiptBulkWebHookEvent":{"properties":{"payload":{"$ref":"#/components/schemas/InboundProcessReceiptBulkWebHookEventPayload"}},"required":["payload"],"title":"InboundProcessReceiptBulkWebHookEvent","type":"object","description":"InboundProcessReceiptBulkWebHookEvent"},"InboundProcessReceiptBulkWebHookEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InboundDeliverySingleReceiptPayload"},"type":"array"}},"required":["items"],"title":"InboundProcessReceiptBulkWebHookEventPayload","type":"object","description":"InboundProcessReceiptBulkWebHookEventPayload"},"InboundDeliverySingleReceiptPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipt":{"$ref":"#/components/schemas/InboundReceipt"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold","receipt"],"title":"InboundDeliverySingleReceiptPayload","type":"object","description":"InboundDeliverySingleReceiptPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"}}}}
```

## The InboundProcessReceiptBulkWebHookEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessReceiptBulkWebHookEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InboundDeliverySingleReceiptPayload"},"type":"array"}},"required":["items"],"title":"InboundProcessReceiptBulkWebHookEventPayload","type":"object","description":"InboundProcessReceiptBulkWebHookEventPayload"},"InboundDeliverySingleReceiptPayload":{"properties":{"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"},"facilityRef":{"type":"string"},"inboundProcessRef":{"type":"string"},"onHold":{"type":"boolean"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipt":{"$ref":"#/components/schemas/InboundReceipt"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessRef":{"type":"string"}},"required":["inboundProcessRef","facilityRef","status","onHold","receipt"],"title":"InboundDeliverySingleReceiptPayload","type":"object","description":"InboundDeliverySingleReceiptPayload"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"}}}}
```

## The InboundProcessReceiptsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessReceiptsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"receivedDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receivedDate"},"receivedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsListFilter"}],"description":"Nested list search by receivedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}],"description":"Search by status"}},"title":"InboundProcessReceiptsFilter","type":"object","description":"InboundProcessReceiptsFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"},"InboundProcessReceiptsReceivedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsReceivedItemsListFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsListFilter"},"InboundProcessReceiptsReceivedItemsFilter":{"properties":{"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessReceiptsReceivedItemsFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"title":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter","type":"object","description":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}}}}
```

## The InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"title":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter","type":"object","description":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}}}}
```

## The InboundProcessReceiptsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessReceiptsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsListFilter","type":"object","description":"InboundProcessReceiptsListFilter"},"InboundProcessReceiptsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"receivedDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receivedDate"},"receivedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsListFilter"}],"description":"Nested list search by receivedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}],"description":"Search by status"}},"title":"InboundProcessReceiptsFilter","type":"object","description":"InboundProcessReceiptsFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"},"InboundProcessReceiptsReceivedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsReceivedItemsListFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsListFilter"},"InboundProcessReceiptsReceivedItemsFilter":{"properties":{"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessReceiptsReceivedItemsFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"title":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter","type":"object","description":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}}}}
```

## The InboundProcessReceiptsReceivedItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessReceiptsReceivedItemsFilter":{"properties":{"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessReceiptsReceivedItemsFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsFilter"},"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"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"}}}}
```

## The InboundProcessReceiptsReceivedItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessReceiptsReceivedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsReceivedItemsListFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsListFilter"},"InboundProcessReceiptsReceivedItemsFilter":{"properties":{"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessReceiptsReceivedItemsFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsFilter"},"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"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"}}}}
```

## The InboundProcessRequestedDateSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessRequestedDateSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessRequestedDateSort","type":"object","description":"InboundProcessRequestedDateSort"}}}}
```

## The InboundProcessSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessSearchPayload":{"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/InboundProcessSearchQuery"},"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/InboundProcessSort"},"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":"InboundProcessSearchPayload","type":"object","description":"InboundProcessSearchPayload"},"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"},"InboundProcessSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"inboundDate":{"allOf":[{"$ref":"#/components/schemas/DateListFilter"}],"description":"Search by inboundDate"},"or":{"items":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"maxItems":500,"type":"array"},"purchaseOrder":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderFilter"}],"description":"Nested search by purchaseOrder"},"receipts":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsListFilter"}],"description":"Nested list search by receipts"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessStatusTypeEnumFilter"}],"description":"Search by status"},"tenantInboundProcessId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantInboundProcessId"}},"title":"InboundProcessSearchQuery","type":"object","description":"InboundProcessSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"},"DateListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/DateEqFilter"}},"title":"DateListFilter","type":"object","description":"DateListFilter"},"DateEqFilter":{"properties":{"eq":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateEqFilter","type":"object","description":"DateEqFilter"},"InboundProcessPurchaseOrderFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateFilter"}],"description":"Nested search by requestedDate"},"requestedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsListFilter"}],"description":"Nested list search by requestedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"}],"description":"Search by status"},"supplier":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplierFilter"}],"description":"Nested search by supplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransferFilter"}],"description":"Nested search by transfer"}},"title":"InboundProcessPurchaseOrderFilter","type":"object","description":"InboundProcessPurchaseOrderFilter"},"InboundProcessPurchaseOrderRequestedDateFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"}],"description":"Search by type"},"value":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by value"}},"title":"InboundProcessPurchaseOrderRequestedDateFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateFilter"},"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["ASAP","TIME_POINT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"}},"title":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"},"InboundProcessPurchaseOrderRequestedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessPurchaseOrderRequestedItemsListFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsListFilter"},"InboundProcessPurchaseOrderRequestedItemsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessPurchaseOrderRequestedItemsFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"}},"title":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter","type":"object","description":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"},"InboundProcessPurchaseOrderSupplierFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"}},"title":"InboundProcessPurchaseOrderSupplierFilter","type":"object","description":"InboundProcessPurchaseOrderSupplierFilter"},"InboundProcessPurchaseOrderTransferFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"InboundProcessPurchaseOrderTransferFilter","type":"object","description":"InboundProcessPurchaseOrderTransferFilter"},"InboundProcessReceiptsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsListFilter","type":"object","description":"InboundProcessReceiptsListFilter"},"InboundProcessReceiptsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"receivedDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receivedDate"},"receivedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsListFilter"}],"description":"Nested list search by receivedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}],"description":"Search by status"}},"title":"InboundProcessReceiptsFilter","type":"object","description":"InboundProcessReceiptsFilter"},"InboundProcessReceiptsReceivedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsReceivedItemsListFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsListFilter"},"InboundProcessReceiptsReceivedItemsFilter":{"properties":{"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessReceiptsReceivedItemsFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsFilter"},"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"title":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter","type":"object","description":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"InboundProcessStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"title":"InboundProcessStatusTypeEnumFilter","type":"object","description":"InboundProcessStatusTypeEnumFilter"},"InboundProcessSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"po_created":{"enum":["ASC","DESC"],"type":"string"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSort"}},"title":"InboundProcessSort","type":"object","description":"InboundProcessSort"},"InboundProcessPurchaseOrderSort":{"properties":{"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessRequestedDateSort"}]},"supplier":{"$ref":"#/components/schemas/InboundProcessSupplierSort"}},"title":"InboundProcessPurchaseOrderSort","type":"object","description":"InboundProcessPurchaseOrderSort"},"InboundProcessRequestedDateSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessRequestedDateSort","type":"object","description":"InboundProcessRequestedDateSort"},"InboundProcessSupplierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessSupplierSort","type":"object","description":"InboundProcessSupplierSort"}}}}
```

## The InboundProcessSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"inboundDate":{"allOf":[{"$ref":"#/components/schemas/DateListFilter"}],"description":"Search by inboundDate"},"or":{"items":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"maxItems":500,"type":"array"},"purchaseOrder":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderFilter"}],"description":"Nested search by purchaseOrder"},"receipts":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsListFilter"}],"description":"Nested list search by receipts"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessStatusTypeEnumFilter"}],"description":"Search by status"},"tenantInboundProcessId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantInboundProcessId"}},"title":"InboundProcessSearchQuery","type":"object","description":"InboundProcessSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"},"DateListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/DateEqFilter"}},"title":"DateListFilter","type":"object","description":"DateListFilter"},"DateEqFilter":{"properties":{"eq":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateEqFilter","type":"object","description":"DateEqFilter"},"InboundProcessPurchaseOrderFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateFilter"}],"description":"Nested search by requestedDate"},"requestedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsListFilter"}],"description":"Nested list search by requestedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"}],"description":"Search by status"},"supplier":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplierFilter"}],"description":"Nested search by supplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransferFilter"}],"description":"Nested search by transfer"}},"title":"InboundProcessPurchaseOrderFilter","type":"object","description":"InboundProcessPurchaseOrderFilter"},"InboundProcessPurchaseOrderRequestedDateFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"}],"description":"Search by type"},"value":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by value"}},"title":"InboundProcessPurchaseOrderRequestedDateFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateFilter"},"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["ASAP","TIME_POINT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"}},"title":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"},"InboundProcessPurchaseOrderRequestedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessPurchaseOrderRequestedItemsListFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsListFilter"},"InboundProcessPurchaseOrderRequestedItemsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessPurchaseOrderRequestedItemsFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"}},"title":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter","type":"object","description":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"},"InboundProcessPurchaseOrderSupplierFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"}},"title":"InboundProcessPurchaseOrderSupplierFilter","type":"object","description":"InboundProcessPurchaseOrderSupplierFilter"},"InboundProcessPurchaseOrderTransferFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"InboundProcessPurchaseOrderTransferFilter","type":"object","description":"InboundProcessPurchaseOrderTransferFilter"},"InboundProcessReceiptsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsListFilter","type":"object","description":"InboundProcessReceiptsListFilter"},"InboundProcessReceiptsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"receivedDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receivedDate"},"receivedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsListFilter"}],"description":"Nested list search by receivedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}],"description":"Search by status"}},"title":"InboundProcessReceiptsFilter","type":"object","description":"InboundProcessReceiptsFilter"},"InboundProcessReceiptsReceivedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsReceivedItemsListFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsListFilter"},"InboundProcessReceiptsReceivedItemsFilter":{"properties":{"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessReceiptsReceivedItemsFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsFilter"},"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"title":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter","type":"object","description":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"InboundProcessStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"title":"InboundProcessStatusTypeEnumFilter","type":"object","description":"InboundProcessStatusTypeEnumFilter"}}}}
```

## The InboundProcessSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"po_created":{"enum":["ASC","DESC"],"type":"string"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSort"}},"title":"InboundProcessSort","type":"object","description":"InboundProcessSort"},"InboundProcessPurchaseOrderSort":{"properties":{"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessRequestedDateSort"}]},"supplier":{"$ref":"#/components/schemas/InboundProcessSupplierSort"}},"title":"InboundProcessPurchaseOrderSort","type":"object","description":"InboundProcessPurchaseOrderSort"},"InboundProcessRequestedDateSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessRequestedDateSort","type":"object","description":"InboundProcessRequestedDateSort"},"InboundProcessSupplierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessSupplierSort","type":"object","description":"InboundProcessSupplierSort"}}}}
```

## The InboundProcessStatusTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"title":"InboundProcessStatusTypeEnumFilter","type":"object","description":"InboundProcessStatusTypeEnumFilter"}}}}
```

## The InboundProcessSupplierSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundProcessSupplierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessSupplierSort","type":"object","description":"InboundProcessSupplierSort"}}}}
```

## The InboundReceipt object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The InboundReceiptComment object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"}}}}
```

## The InboundReceiptCommentForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"}}}}
```

## The InboundReceiptCommentForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptCommentForUpdate":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForUpdate","type":"object","description":"InboundReceiptCommentForUpdate"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"}}}}
```

## The InboundReceiptForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptForCreation":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"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"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForCreation"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments"],"title":"InboundReceiptForCreation","type":"object","description":"InboundReceiptForCreation"},"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForCreation":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"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"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForCreation","type":"object","description":"InboundReceiptLineItemForCreation"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The InboundReceiptForPatch object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptForPatch":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"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"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForUpdate"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["version"],"title":"InboundReceiptForPatch","type":"object","description":"InboundReceiptForPatch"},"InboundReceiptCommentForUpdate":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForUpdate","type":"object","description":"InboundReceiptCommentForUpdate"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForUpdate":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receival of this item","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForUpdate","type":"object","description":"InboundReceiptLineItemForUpdate"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The InboundReceiptForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptForUpdate":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"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"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForUpdate"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","version"],"title":"InboundReceiptForUpdate","type":"object","description":"InboundReceiptForUpdate"},"InboundReceiptCommentForUpdate":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForUpdate","type":"object","description":"InboundReceiptCommentForUpdate"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForUpdate":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receival of this item","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForUpdate","type":"object","description":"InboundReceiptLineItemForUpdate"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The InboundReceiptJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptJob":{"properties":{"expectedDate":{"$ref":"#/components/schemas/RequestedDate"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"items":{"$ref":"#/components/schemas/InboundLineItem"},"origin":{"$ref":"#/components/schemas/InboundReceiptJobOrigin"},"originReadableId":{"type":"string"},"originReadableName":{"type":"string"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"required":["id","facilityRef","inboundProcessRef","status","expectedDate","items","origin"],"title":"InboundReceiptJob","type":"object","description":"InboundReceiptJob"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundReceiptJobOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundReceiptJobOrigin","type":"object","description":"InboundReceiptJobOrigin"}}}}
```

## The InboundReceiptJobOrigin object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptJobOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundReceiptJobOrigin","type":"object","description":"InboundReceiptJobOrigin"}}}}
```

## The InboundReceiptJobPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptJobPaginatedResult":{"properties":{"inboundReceiptJobs":{"items":{"$ref":"#/components/schemas/InboundReceiptJob"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","inboundReceiptJobs"],"title":"InboundReceiptJobPaginatedResult","type":"object","description":"InboundReceiptJobPaginatedResult"},"InboundReceiptJob":{"properties":{"expectedDate":{"$ref":"#/components/schemas/RequestedDate"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"items":{"$ref":"#/components/schemas/InboundLineItem"},"origin":{"$ref":"#/components/schemas/InboundReceiptJobOrigin"},"originReadableId":{"type":"string"},"originReadableName":{"type":"string"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"required":["id","facilityRef","inboundProcessRef","status","expectedDate","items","origin"],"title":"InboundReceiptJob","type":"object","description":"InboundReceiptJob"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundReceiptJobOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundReceiptJobOrigin","type":"object","description":"InboundReceiptJobOrigin"}}}}
```

## The InboundReceiptLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The InboundReceiptLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptLineItemForCreation":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"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"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForCreation","type":"object","description":"InboundReceiptLineItemForCreation"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The InboundReceiptLineItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InboundReceiptLineItemForUpdate":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receival of this item","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForUpdate","type":"object","description":"InboundReceiptLineItemForUpdate"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"InboundReceiptCommentForUpdate":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForUpdate","type":"object","description":"InboundReceiptCommentForUpdate"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The InheritedDocumentConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InheritedDocumentConfiguration":{"properties":{"section":{"$ref":"#/components/schemas/Section"}},"required":["section"],"title":"InheritedDocumentConfiguration","description":"InheritedDocumentConfiguration"},"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"}}}}
```

## The InheritedServiceJobLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"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":"Unique ID of this inherited line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"}}}}
```

## The InputRequestedDate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"}}}}
```

## The IntegerValidation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"IntegerValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as integer.","properties":{"maxValue":{"type":"number"},"minValue":{"type":"number"}},"title":"IntegerValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"}}}}
```

## The InterFacilityConnection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnection":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"id":{"type":"string"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"sourceFacilityRef":{"type":"string"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"target":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionCustomerTarget","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget","SUPPLIER":"#/components/schemas/InterFacilityConnectionSupplierTarget"}}},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"}},"required":["id","sourceFacilityRef","target"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnection","description":"InterFacilityConnection"},"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"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The InterFacilityConnectionBaseTarget object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"}}}}
```

## The InterFacilityConnectionContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"}}}}
```

## The InterFacilityConnectionContextTypes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"}}}}
```

## The InterFacilityConnectionCostCoefficient object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The InterFacilityConnectionCustomerTarget object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"}}}}
```

## The InterFacilityConnectionDeliveryCost object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"}}}}
```

## The InterFacilityConnectionFallbackCost object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionFallbackCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionFallbackCost","description":"InterFacilityConnectionFallbackCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The InterFacilityConnectionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionForCreation":{"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionForCreation"},"title":"InterFacilityConnectionForCreation","description":"InterFacilityConnectionForCreation"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"}}}}
```

## The InterFacilityConnectionForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionForUpdate":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"},"version":{"type":"number"}},"required":["version","type"],"type":"object","xml":{"name":"InterFacilityConnectionForUpdate"},"title":"InterFacilityConnectionForUpdate","description":"InterFacilityConnectionForUpdate"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"}}}}
```

## The InterFacilityConnectionGeneralShipmentRestriction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"}}}}
```

## The InterFacilityConnectionGeneralShipmentRestrictionType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"}}}}
```

## The InterFacilityConnectionManagedFacilityTarget object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"}}}}
```

## The InterFacilityConnectionPackageTypeSpecificShipmentRestriction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"}}}}
```

## The InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"}}}}
```

## The InterFacilityConnectionPricesByTier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The InterFacilityConnectionPricingBasis object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"}}}}
```

## The InterFacilityConnectionPricingByZone object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"}}}}
```

## The InterFacilityConnectionPricingMeasurementUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"}}}}
```

## The InterFacilityConnectionPricingOverflowFactor object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The InterFacilityConnectionPricingQuantity object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"}}}}
```

## The InterFacilityConnectionPricingUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"}}}}
```

## The InterFacilityConnections object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnections":{"additionalProperties":false,"properties":{"interFacilityConnections":{"items":{"$ref":"#/components/schemas/InterFacilityConnection"},"type":"array"},"total":{"description":"Total number of entities found for this query","type":"integer"}},"required":["interFacilityConnections","total"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnections","description":"InterFacilityConnections"},"InterFacilityConnection":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"id":{"type":"string"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"sourceFacilityRef":{"type":"string"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"target":{"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"}],"discriminator":{"propertyName":"type","mapping":{"CUSTOMER":"#/components/schemas/InterFacilityConnectionCustomerTarget","MANAGED_FACILITY":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget","SUPPLIER":"#/components/schemas/InterFacilityConnectionSupplierTarget"}}},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"}},"required":["id","sourceFacilityRef","target"],"type":"object","xml":{"name":"InterFacilityConnection"},"title":"InterFacilityConnection","description":"InterFacilityConnection"},"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"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The InterFacilityConnectionsMoney object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The InterFacilityConnectionSupplierTarget object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"}}}}
```

## The InterFacilityConnectionSurchargeContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"}}}}
```

## The InterFacilityConnectionSurchargeContextTypes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"}}}}
```

## The InterFacilityConnectionToCustomerForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionToCustomerForCreation":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["target","type"],"type":"object","xml":{"name":"InterFacilityConnectionToCustomerForCreation"},"title":"InterFacilityConnectionToCustomerForCreation","description":"InterFacilityConnectionToCustomerForCreation"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The InterFacilityConnectionToCustomerForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionToCustomerForUpdate":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionCustomerTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"},"version":{"type":"number"}},"required":["target","version","type"],"type":"object","xml":{"name":"InterFacilityConnectionToCustomerForUpdate"},"title":"InterFacilityConnectionToCustomerForUpdate","description":"InterFacilityConnectionToCustomerForUpdate"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionCustomerTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"type":"object","title":"InterFacilityConnectionCustomerTarget","description":"InterFacilityConnectionCustomerTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The InterFacilityConnectionToManagedFacilityForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionToManagedFacilityForCreation":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["target","type"],"type":"object","xml":{"name":"InterFacilityConnectionToManagedFacilityForCreation"},"title":"InterFacilityConnectionToManagedFacilityForCreation","description":"InterFacilityConnectionToManagedFacilityForCreation"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The InterFacilityConnectionToManagedFacilityForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionToManagedFacilityForUpdate":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionManagedFacilityTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"},"version":{"type":"number"}},"required":["target","version","type"],"type":"object","xml":{"name":"InterFacilityConnectionToManagedFacilityForUpdate"},"title":"InterFacilityConnectionToManagedFacilityForUpdate","description":"InterFacilityConnectionToManagedFacilityForUpdate"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionManagedFacilityTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionManagedFacilityTarget","description":"InterFacilityConnectionManagedFacilityTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The InterFacilityConnectionToSupplierForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionToSupplierForCreation":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["target","type"],"type":"object","xml":{"name":"InterFacilityConnectionToSupplierForCreation"},"title":"InterFacilityConnectionToSupplierForCreation","description":"InterFacilityConnectionToSupplierForCreation"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The InterFacilityConnectionToSupplierForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionToSupplierForUpdate":{"additionalProperties":false,"properties":{"carrierKey":{"description":"The key of the carrier that is used for this connection. References known and configured carriers in the system.","type":"string"},"carrierName":{"description":"The name of the carrier that is used for this connection.","type":"string"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionContext"},"maxItems":500,"minItems":0,"type":"array"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes that can be used to store additional information about the connection.","type":"object"},"cutoffTimes":{"$ref":"#/components/schemas/CarrierCutoffTimes"},"fallbackCosts":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"maxItems":500,"type":"array"},"fallbackTransitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"generalShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestriction"},"maxItems":50,"type":"array"},"nonDeliveryDays":{"items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"packageTypeSpecificShipmentRestrictions":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"maxItems":50,"type":"array"},"packagingUnitsByContexts":{"items":{"$ref":"#/components/schemas/PackagingUnitsByContext"},"maxItems":500,"minItems":0,"type":"array"},"pricingPerTransfer":{"$ref":"#/components/schemas/InterFacilityConnectionTransferPricing"},"surchargesPerTransfer":{"items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferAbsoluteSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferRelativeSurcharge"},{"$ref":"#/components/schemas/InterFacilityConnectionTransferThresholdSurcharge"}]},"maxItems":500,"type":"array"},"target":{"$ref":"#/components/schemas/InterFacilityConnectionSupplierTarget"},"transportDetails":{"$ref":"#/components/schemas/TransportDetails"},"type":{"$ref":"#/components/schemas/ConnectionType"},"version":{"type":"number"}},"required":["target","version","type"],"type":"object","xml":{"name":"InterFacilityConnectionToSupplierForUpdate"},"title":"InterFacilityConnectionToSupplierForUpdate","description":"InterFacilityConnectionToSupplierForUpdate"},"InterFacilityConnectionContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionContext","description":"InterFacilityConnectionContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionContextTypes":{"enum":["FACILITY","FACILITY_GROUP","CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionContextTypes","description":"InterFacilityConnectionContextTypes"},"CarrierCutoffTimes":{"nullable":true,"properties":{"overwrites":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesOverwrite"},"type":"array"},"weekdays":{"items":{"$ref":"#/components/schemas/CarrierCutoffTimesWeekDay"},"type":"array"}},"required":["weekdays","overwrites"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimes","description":"CarrierCutoffTimes"},"CarrierCutoffTimesOverwrite":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"date":{"format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"required":["date","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffTimesOverwrite","description":"CarrierCutoffTimesOverwrite"},"CarrierCutoffConfiguration":{"properties":{"capacity":{"type":"number"},"time":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$","type":"string"}},"required":["time"],"type":"object","xml":{"name":"CarrierCutoffTimes"},"title":"CarrierCutoffConfiguration","description":"CarrierCutoffConfiguration"},"CarrierCutoffTimesWeekDay":{"properties":{"cutoffConfigurations":{"items":{"$ref":"#/components/schemas/CarrierCutoffConfiguration"},"type":"array"},"day":{"$ref":"#/components/schemas/WeekDay"}},"required":["day","cutoffConfigurations"],"type":"object","xml":{"name":"CarrierCutoffTimesWeekDay"},"title":"CarrierCutoffTimesWeekDay","description":"CarrierCutoffTimesWeekDay"},"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"InterFacilityConnectionGeneralShipmentRestriction":{"properties":{"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionGeneralShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value"],"type":"object","title":"InterFacilityConnectionGeneralShipmentRestriction","description":"InterFacilityConnectionGeneralShipmentRestriction"},"InterFacilityConnectionGeneralShipmentRestrictionType":{"enum":["MAX_WEIGHT_PER_SHIPMENT","MAX_LOADING_METERS_PER_SHIPMENT","MAX_PACKAGING_UNITS_PER_SHIPMENT","MIN_PACKAGING_UNITS_PER_SHIPMENT","MAX_WEIGHT_PER_LOADING_METER"],"type":"string","title":"InterFacilityConnectionGeneralShipmentRestrictionType","description":"InterFacilityConnectionGeneralShipmentRestrictionType"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"InterFacilityConnectionPackageTypeSpecificShipmentRestriction":{"properties":{"packagingUnitRefs":{"items":{"type":"string"},"type":"array"},"packagingUnitType":{"$ref":"#/components/schemas/PackagingUnitType"},"restrictionType":{"$ref":"#/components/schemas/InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"value":{"type":"number"}},"required":["restrictionType","value","packagingUnitType"],"type":"object","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestriction"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType":{"enum":["MAX_PACKAGING_UNITS_PER_TYPE"],"type":"string","title":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType","description":"InterFacilityConnectionPackageTypeSpecificShipmentRestrictionType"},"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"},"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"},"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionSupplierTarget":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionBaseTarget"}],"properties":{"excludedFacilityGroupRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"excludedFacilityRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"facilityRef":{"type":"string"}},"type":"object","title":"InterFacilityConnectionSupplierTarget","description":"InterFacilityConnectionSupplierTarget"},"InterFacilityConnectionBaseTarget":{"discriminator":{"propertyName":"type"},"properties":{"type":{"$ref":"#/components/schemas/ConnectionType"}},"required":["type"],"type":"object","xml":{"name":"InterFacilityConnectionBaseTarget"},"title":"InterFacilityConnectionBaseTarget","description":"InterFacilityConnectionBaseTarget"},"ConnectionType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"ConnectionType","description":"ConnectionType"},"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The InterFacilityConnectionTransferAbsoluteSurcharge object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionTransferAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["ABSOLUTE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","amount"],"title":"InterFacilityConnectionTransferAbsoluteSurcharge","type":"object","description":"InterFacilityConnectionTransferAbsoluteSurcharge"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"}}}}
```

## The InterFacilityConnectionTransferPricing object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionTransferPricing":{"additionalProperties":false,"description":"Prices the transfer as one shipment instead of per packaging unit, for carriers whose tariff charges the aggregated weight of all packaging units of a transfer (e.g. UPS Italy). When this is configured, the base price is resolved once per transfer from `pricing` and the prices configured on the packaging units of that transfer are ignored. Surcharges are unaffected: those configured per packaging unit and those in `surchargesPerTransfer` both still apply, each on its own level.","properties":{"costCoefficient":{"$ref":"#/components/schemas/InterFacilityConnectionCostCoefficient"},"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","format":"float","minimum":0,"type":"number"},"maxVolumetricWeight":{"description":"Caps the chargeable volumetric weight in grams.","minimum":0,"type":"integer"},"pricing":{"description":"The price matrix of this connection, by zone.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingByZone"},"maxItems":500,"minItems":1,"type":"array"},"pricingBasis":{"$ref":"#/components/schemas/InterFacilityConnectionPricingBasis"},"volumeBufferInPercent":{"description":"The buffer in percent applied to the aggregated volume of all packaging units.","minimum":0,"type":"integer"},"volumetricWeightFactor":{"description":"Converts the aggregated volume of all packaging units into a volumetric weight.","format":"float","minimum":0,"type":"number"},"weightToVolumeFactor":{"description":"Converts the aggregated weight of all packaging units into a volume. Required when pricingUnit is CUBIC_METER.","format":"float","minimum":0,"type":"number"}},"required":["pricing"],"title":"InterFacilityConnectionTransferPricing","type":"object"},"InterFacilityConnectionCostCoefficient":{"additionalProperties":false,"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"measurementUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingMeasurementUnit"},"value":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["value","measurementUnit"],"title":"InterFacilityConnectionCostCoefficient","type":"object"},"InterFacilityConnectionPricingMeasurementUnit":{"description":"The unit of measurement for the cost coefficient.","enum":["GRAM","CUBIC_METER"],"title":"InterFacilityConnectionPricingMeasurementUnit","type":"string"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"InterFacilityConnectionPricingByZone":{"additionalProperties":false,"properties":{"overflowFactor":{"$ref":"#/components/schemas/InterFacilityConnectionPricingOverflowFactor"},"prices":{"description":"The prices of this zone, by upper threshold.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricesByTier"},"maxItems":500,"minItems":1,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please provide the ISO 3166-2 country code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","pattern":"^[A-Z]{2}-\\d+$","type":"string"}},"required":["prices"],"title":"InterFacilityConnectionPricingByZone","type":"object","description":"InterFacilityConnectionPricingByZone"},"InterFacilityConnectionPricingOverflowFactor":{"additionalProperties":false,"description":"Additional costs in case the price definition is exceeded.","properties":{"factor":{"description":"The factor appliable when the highest configured threshold is exceeded.","format":"float","minimum":0,"type":"number"},"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"}},"required":["price","factor"],"title":"InterFacilityConnectionPricingOverflowFactor","type":"object"},"InterFacilityConnectionPricesByTier":{"additionalProperties":false,"properties":{"price":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"upperThreshold":{"description":"The threshold in pricingUnit up to which this price applies.","format":"int64","minimum":0,"type":"integer"}},"required":["upperThreshold","price"],"title":"InterFacilityConnectionPricesByTier","type":"object","description":"InterFacilityConnectionPricesByTier"},"InterFacilityConnectionPricingBasis":{"additionalProperties":false,"properties":{"pricingQuantities":{"description":"The quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount.","items":{"$ref":"#/components/schemas/InterFacilityConnectionPricingQuantity"},"maxItems":3,"minItems":1,"type":"array"},"pricingUnit":{"$ref":"#/components/schemas/InterFacilityConnectionPricingUnit"}},"required":["pricingUnit","pricingQuantities"],"title":"InterFacilityConnectionPricingBasis","type":"object","description":"InterFacilityConnectionPricingBasis"},"InterFacilityConnectionPricingQuantity":{"description":"A quantity of the transfer that can determine the chargeable amount.","enum":["ACTUAL_WEIGHT","VOLUMETRIC_WEIGHT","LOADING_METER_EQUIVALENT"],"title":"InterFacilityConnectionPricingQuantity","type":"string"},"InterFacilityConnectionPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"InterFacilityConnectionPricingUnit","type":"string"}}}}
```

## The InterFacilityConnectionTransferRelativeSurcharge object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionTransferRelativeSurcharge":{"properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["RELATIVE_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","percentage"],"title":"InterFacilityConnectionTransferRelativeSurcharge","type":"object","description":"InterFacilityConnectionTransferRelativeSurcharge"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"}}}}
```

## The InterFacilityConnectionTransferSurchargeType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"}}}}
```

## The InterFacilityConnectionTransferThresholdSurcharge object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InterFacilityConnectionTransferThresholdSurcharge":{"description":"A surcharge that is charged as the greater of minimumAmount and percentage of the amount it is applied to, for example a cash on delivery fee of at least 5.80 EUR but 3 % of a larger transfer.","properties":{"context":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContext"},"maxItems":500,"minItems":0,"type":"array"},"minimumAmount":{"$ref":"#/components/schemas/InterFacilityConnectionsMoney"},"percentage":{"format":"float","minimum":0,"type":"number"},"tenantSurchargeType":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/InterFacilityConnectionTransferSurchargeType"}],"enum":["THRESHOLD_SURCHARGE_TYPE"]}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"InterFacilityConnectionTransferThresholdSurcharge","type":"object"},"InterFacilityConnectionSurchargeContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/InterFacilityConnectionSurchargeContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"InterFacilityConnectionSurchargeContext","description":"InterFacilityConnectionSurchargeContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"InterFacilityConnectionSurchargeContextTypes":{"enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"type":"string","title":"InterFacilityConnectionSurchargeContextTypes","description":"InterFacilityConnectionSurchargeContextTypes"},"InterFacilityConnectionsMoney":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value in the smallest subunit of the given currency, e.g. cents.","minimum":0,"type":"integer"}},"required":["currency","value"],"title":"InterFacilityConnectionsMoney","type":"object","description":"InterFacilityConnectionsMoney"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"InterFacilityConnectionTransferSurchargeType":{"enum":["ABSOLUTE_SURCHARGE_TYPE","RELATIVE_SURCHARGE_TYPE","THRESHOLD_SURCHARGE_TYPE"],"title":"InterFacilityConnectionTransferSurchargeType","type":"string","description":"InterFacilityConnectionTransferSurchargeType"}}}}
```

## The InventoryArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"type":"array"},"imageUrl":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["imageUrl","tenantArticleId","title"],"title":"InventoryArticle","type":"object","description":"InventoryArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The InventoryArticleAvailabilityChangedEventScope object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryArticleAvailabilityChangedEventScope":{"properties":{"created":{"format":"date-time","type":"string"},"facilityGroupRefs":{"items":{"type":"string"},"type":"array"},"facilityRefs":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"key":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"type":"number"}},"required":["id","key","status","version","created","lastModified"],"title":"InventoryArticleAvailabilityChangedEventScope","type":"object","description":"InventoryArticleAvailabilityChangedEventScope"}}}}
```

## The InventoryArticleAvailabilityChangedEventScopeForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryArticleAvailabilityChangedEventScopeForCreation":{"properties":{"facilityGroupRefs":{"description":"Facility group references whose members are included in this scope. Omit or null for a global scope including all facilities.","items":{"type":"string"},"maxItems":5,"nullable":true,"type":"array"},"facilityRefs":{"description":"Direct facility references to include in this scope. Omit or null for a global scope including all facilities.","items":{"type":"string"},"maxItems":50,"nullable":true,"type":"array"},"key":{"description":"Unique key identifying this scope. Used to derive the URN.","maxLength":128,"type":"string"},"status":{"default":"ACTIVE","description":"A scope config can be set to inactive instead of being deleted to temporarily disable emission. The maximum limit of 10 applies to both active and inactive scope configs.","enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["key"],"title":"InventoryArticleAvailabilityChangedEventScopeForCreation","type":"object","description":"InventoryArticleAvailabilityChangedEventScopeForCreation"}}}}
```

## The InventoryArticleAvailabilityChangedEventScopeForReplace object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryArticleAvailabilityChangedEventScopeForReplace":{"properties":{"facilityGroupRefs":{"description":"Facility group references whose members are included in this scope. Omit or null for a global scope including all facilities.","items":{"type":"string"},"maxItems":5,"nullable":true,"type":"array"},"facilityRefs":{"description":"Direct facility references to include in this scope. Omit or null for a global scope including all facilities.","items":{"type":"string"},"maxItems":50,"nullable":true,"type":"array"},"status":{"description":"A scope config can be set to inactive instead of being deleted to temporarily disable emission. The maximum limit of 10 applies to both active and inactive scope configs.","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"Version for optimistic locking.","type":"number"}},"required":["version"],"title":"InventoryArticleAvailabilityChangedEventScopeForReplace","type":"object","description":"InventoryArticleAvailabilityChangedEventScopeForReplace"}}}}
```

## The InventoryArticleAvailabilityChangedPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryArticleAvailabilityChangedPayload":{"properties":{"articleAvailability":{"$ref":"#/components/schemas/ArticleAvailabilityStockValues"},"configurationScopeKey":{"type":"string"},"emittedAt":{"format":"date-time","type":"string"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","configurationScopeKey","articleAvailability","emittedAt"],"title":"InventoryArticleAvailabilityChangedPayload","type":"object","description":"InventoryArticleAvailabilityChangedPayload"},"ArticleAvailabilityStockValues":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"stockOnHand":{"type":"number"},"total":{"type":"number"}},"required":["total","stockOnHand","availableOnStock","availableForPicking"],"title":"ArticleAvailabilityStockValues","type":"object","description":"ArticleAvailabilityStockValues"}}}}
```

## The InventoryArticleAvailabilityChangedPayloadWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryArticleAvailabilityChangedPayloadWebHookEvent":{"properties":{"payload":{"$ref":"#/components/schemas/InventoryArticleAvailabilityChangedPayload"}},"required":["payload"],"title":"InventoryArticleAvailabilityChangedPayloadWebHookEvent","type":"object","description":"InventoryArticleAvailabilityChangedPayloadWebHookEvent"},"InventoryArticleAvailabilityChangedPayload":{"properties":{"articleAvailability":{"$ref":"#/components/schemas/ArticleAvailabilityStockValues"},"configurationScopeKey":{"type":"string"},"emittedAt":{"format":"date-time","type":"string"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","configurationScopeKey","articleAvailability","emittedAt"],"title":"InventoryArticleAvailabilityChangedPayload","type":"object","description":"InventoryArticleAvailabilityChangedPayload"},"ArticleAvailabilityStockValues":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"stockOnHand":{"type":"number"},"total":{"type":"number"}},"required":["total","stockOnHand","availableOnStock","availableForPicking"],"title":"ArticleAvailabilityStockValues","type":"object","description":"ArticleAvailabilityStockValues"}}}}
```

## The InventoryArticlePaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryArticlePaginatedResult":{"properties":{"articles":{"items":{"$ref":"#/components/schemas/InventoryArticle"},"type":"array"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"total":{"minimum":0,"type":"number"}},"required":["total","pageInfo","articles"],"title":"InventoryArticlePaginatedResult","type":"object","description":"InventoryArticlePaginatedResult"},"InventoryArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"type":"array"},"imageUrl":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["imageUrl","tenantArticleId","title"],"title":"InventoryArticle","type":"object","description":"InventoryArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"}}}}
```

## The InventoryAvailabilityTimeframe object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryAvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"title":"InventoryAvailabilityTimeframe","type":"object","description":"InventoryAvailabilityTimeframe"}}}}
```

## The InventoryAvailableUntilDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryAvailableUntilDefinition":{"properties":{"calculationBase":{"enum":["CREATION","EXPIRY"],"type":"string"},"modifier":{"type":"string"}},"required":["calculationBase"],"title":"InventoryAvailableUntilDefinition","type":"object","description":"InventoryAvailableUntilDefinition"}}}}
```

## The InventoryConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryConfiguration":{"properties":{"isMixedStorage":{"type":"boolean"},"version":{"type":"number"}},"required":["version"],"title":"InventoryConfiguration","type":"object","description":"InventoryConfiguration"}}}}
```

## The InventoryConfigurationForPatch object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryConfigurationForPatch":{"properties":{"isMixedStorage":{"nullable":true,"type":"boolean"},"version":{"type":"number"}},"required":["version"],"title":"InventoryConfigurationForPatch","type":"object","description":"InventoryConfigurationForPatch"}}}}
```

## The InventoryFacilityConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryFacilityConfiguration":{"properties":{"facilityRef":{"type":"string"},"id":{"type":"string"},"isMixedStorage":{"type":"boolean"},"outboundStockConfiguration":{"$ref":"#/components/schemas/OutboundStockConfiguration"},"version":{"type":"number"}},"required":["id","version","facilityRef"],"title":"InventoryFacilityConfiguration","type":"object","description":"InventoryFacilityConfiguration"},"OutboundStockConfiguration":{"properties":{"clearTrigger":{"items":{"$ref":"#/components/schemas/OutboundClearTrigger"},"type":"array"},"locationRef":{"type":"string"},"trackOutboundStock":{"type":"boolean"}},"required":["trackOutboundStock","locationRef"],"title":"OutboundStockConfiguration","type":"object","description":"OutboundStockConfiguration"},"OutboundClearTrigger":{"properties":{"event":{"enum":["pick-job-closed_event-v1","handoverjob-handed-over_event-v1"],"type":"string"},"tagFilter":{"items":{"$ref":"#/components/schemas/OutboundTagFilter"},"type":"array"}},"required":["event"],"title":"OutboundClearTrigger","type":"object","description":"OutboundClearTrigger"},"OutboundTagFilter":{"properties":{"allowedValues":{"items":{"type":"string"},"type":"array"},"tagId":{"type":"string"}},"required":["allowedValues","tagId"],"title":"OutboundTagFilter","type":"object","description":"OutboundTagFilter"}}}}
```

## The InventoryFacilityConfigurationForPatch object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryFacilityConfigurationForPatch":{"properties":{"isMixedStorage":{"nullable":true,"type":"boolean"},"outboundStockConfiguration":{"$ref":"#/components/schemas/OutboundStockConfiguration"},"version":{"type":"number"}},"required":["version"],"title":"InventoryFacilityConfigurationForPatch","type":"object","description":"InventoryFacilityConfigurationForPatch"},"OutboundStockConfiguration":{"properties":{"clearTrigger":{"items":{"$ref":"#/components/schemas/OutboundClearTrigger"},"type":"array"},"locationRef":{"type":"string"},"trackOutboundStock":{"type":"boolean"}},"required":["trackOutboundStock","locationRef"],"title":"OutboundStockConfiguration","type":"object","description":"OutboundStockConfiguration"},"OutboundClearTrigger":{"properties":{"event":{"enum":["pick-job-closed_event-v1","handoverjob-handed-over_event-v1"],"type":"string"},"tagFilter":{"items":{"$ref":"#/components/schemas/OutboundTagFilter"},"type":"array"}},"required":["event"],"title":"OutboundClearTrigger","type":"object","description":"OutboundClearTrigger"},"OutboundTagFilter":{"properties":{"allowedValues":{"items":{"type":"string"},"type":"array"},"tagId":{"type":"string"}},"required":["allowedValues","tagId"],"title":"OutboundTagFilter","type":"object","description":"OutboundTagFilter"}}}}
```

## The InventoryFacilityReferences object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryFacilityReferences":{"properties":{"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityRef"],"title":"InventoryFacilityReferences","type":"object","description":"InventoryFacilityReferences"}}}}
```

## The InventoryFacilityStockChangedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryFacilityStockChangedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"items":{"$ref":"#/components/schemas/InventoryFacilityStockShape"},"type":"array"}},"required":["payload"],"type":"object","title":"InventoryFacilityStockChangedWebHookEvent","description":"InventoryFacilityStockChangedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"InventoryFacilityStockShape":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"availableForPicking":{"type":"number"},"availableForPickingDetails":{"$ref":"#/components/schemas/AvailableForPickingDetails"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/InventoryFacilityStockShapeByTrait"},"changeReason":{"enum":["UNKNOWN"],"type":"string"},"delta":{"$ref":"#/components/schemas/InventoryFacilityStockDeltaShape"},"facility":{"$ref":"#/components/schemas/InventoryFacilityReferences"},"facilityRef":{"type":"string"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"type":"number"},"safetyStock":{"type":"number"},"staleReasons":{"items":{"$ref":"#/components/schemas/InventoryFacilityStockStaleReason"},"type":"array"},"stockOnHand":{"type":"number"},"tenantArticleId":{"type":"string"},"totalAmount":{"type":"number"}},"required":["facilityRef","facility","tenantArticleId","totalAmount","reserved","safetyStock","available","byTrait","changeReason","availableToPromise","readyToPick","availableForPicking","availableForPickingDetails","delta","staleReasons","stockOnHand","availableOnStock"],"title":"InventoryFacilityStockShape","type":"object","description":"InventoryFacilityStockShape"},"AvailableForPickingDetails":{"properties":{"total":{"type":"number"}},"required":["total"],"title":"AvailableForPickingDetails","type":"object","description":"AvailableForPickingDetails"},"InventoryFacilityStockShapeByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"InventoryFacilityStockShapeByTrait","type":"object","description":"InventoryFacilityStockShapeByTrait"},"InventoryFacilityStockDeltaShape":{"properties":{"available":{"deprecated":true,"type":"number"},"availableForPicking":{"type":"number"},"availableForPickingDetails":{"$ref":"#/components/schemas/AvailableForPickingDetails"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"type":"number"},"byTrait":{"$ref":"#/components/schemas/InventoryFacilityStockShapeByTrait"},"readyToPick":{"deprecated":true,"type":"number"},"reserved":{"type":"number"},"safetyStock":{"type":"number"},"stockCount":{"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"type":"number"}},"required":["totalAmount","reserved","safetyStock","available","byTrait","availableToPromise","readyToPick","availableForPicking","stockCount","availableOnStock","stockOnHand","availableForPickingDetails"],"title":"InventoryFacilityStockDeltaShape","type":"object","description":"InventoryFacilityStockDeltaShape"},"InventoryFacilityReferences":{"properties":{"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityRef"],"title":"InventoryFacilityReferences","type":"object","description":"InventoryFacilityReferences"},"InventoryFacilityStockStaleReason":{"properties":{"reasons":{"items":{"type":"string"},"type":"array"},"timestamp":{"format":"date-time","type":"string"}},"required":["timestamp","reasons"],"title":"InventoryFacilityStockStaleReason","type":"object","description":"InventoryFacilityStockStaleReason"}}}}
```

## The InventoryFacilityStockDeltaShape object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryFacilityStockDeltaShape":{"properties":{"available":{"deprecated":true,"type":"number"},"availableForPicking":{"type":"number"},"availableForPickingDetails":{"$ref":"#/components/schemas/AvailableForPickingDetails"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"type":"number"},"byTrait":{"$ref":"#/components/schemas/InventoryFacilityStockShapeByTrait"},"readyToPick":{"deprecated":true,"type":"number"},"reserved":{"type":"number"},"safetyStock":{"type":"number"},"stockCount":{"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"type":"number"}},"required":["totalAmount","reserved","safetyStock","available","byTrait","availableToPromise","readyToPick","availableForPicking","stockCount","availableOnStock","stockOnHand","availableForPickingDetails"],"title":"InventoryFacilityStockDeltaShape","type":"object","description":"InventoryFacilityStockDeltaShape"},"AvailableForPickingDetails":{"properties":{"total":{"type":"number"}},"required":["total"],"title":"AvailableForPickingDetails","type":"object","description":"AvailableForPickingDetails"},"InventoryFacilityStockShapeByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"InventoryFacilityStockShapeByTrait","type":"object","description":"InventoryFacilityStockShapeByTrait"}}}}
```

## The InventoryFacilityStockShape object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryFacilityStockShape":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"availableForPicking":{"type":"number"},"availableForPickingDetails":{"$ref":"#/components/schemas/AvailableForPickingDetails"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/InventoryFacilityStockShapeByTrait"},"changeReason":{"enum":["UNKNOWN"],"type":"string"},"delta":{"$ref":"#/components/schemas/InventoryFacilityStockDeltaShape"},"facility":{"$ref":"#/components/schemas/InventoryFacilityReferences"},"facilityRef":{"type":"string"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"type":"number"},"safetyStock":{"type":"number"},"staleReasons":{"items":{"$ref":"#/components/schemas/InventoryFacilityStockStaleReason"},"type":"array"},"stockOnHand":{"type":"number"},"tenantArticleId":{"type":"string"},"totalAmount":{"type":"number"}},"required":["facilityRef","facility","tenantArticleId","totalAmount","reserved","safetyStock","available","byTrait","changeReason","availableToPromise","readyToPick","availableForPicking","availableForPickingDetails","delta","staleReasons","stockOnHand","availableOnStock"],"title":"InventoryFacilityStockShape","type":"object","description":"InventoryFacilityStockShape"},"AvailableForPickingDetails":{"properties":{"total":{"type":"number"}},"required":["total"],"title":"AvailableForPickingDetails","type":"object","description":"AvailableForPickingDetails"},"InventoryFacilityStockShapeByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"InventoryFacilityStockShapeByTrait","type":"object","description":"InventoryFacilityStockShapeByTrait"},"InventoryFacilityStockDeltaShape":{"properties":{"available":{"deprecated":true,"type":"number"},"availableForPicking":{"type":"number"},"availableForPickingDetails":{"$ref":"#/components/schemas/AvailableForPickingDetails"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"type":"number"},"byTrait":{"$ref":"#/components/schemas/InventoryFacilityStockShapeByTrait"},"readyToPick":{"deprecated":true,"type":"number"},"reserved":{"type":"number"},"safetyStock":{"type":"number"},"stockCount":{"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"type":"number"}},"required":["totalAmount","reserved","safetyStock","available","byTrait","availableToPromise","readyToPick","availableForPicking","stockCount","availableOnStock","stockOnHand","availableForPickingDetails"],"title":"InventoryFacilityStockDeltaShape","type":"object","description":"InventoryFacilityStockDeltaShape"},"InventoryFacilityReferences":{"properties":{"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityRef"],"title":"InventoryFacilityReferences","type":"object","description":"InventoryFacilityReferences"},"InventoryFacilityStockStaleReason":{"properties":{"reasons":{"items":{"type":"string"},"type":"array"},"timestamp":{"format":"date-time","type":"string"}},"required":["timestamp","reasons"],"title":"InventoryFacilityStockStaleReason","type":"object","description":"InventoryFacilityStockStaleReason"}}}}
```

## The InventoryFacilityStockShapeByTrait object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryFacilityStockShapeByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"InventoryFacilityStockShapeByTrait","type":"object","description":"InventoryFacilityStockShapeByTrait"}}}}
```

## The InventoryFacilityStockStaleReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryFacilityStockStaleReason":{"properties":{"reasons":{"items":{"type":"string"},"type":"array"},"timestamp":{"format":"date-time","type":"string"}},"required":["timestamp","reasons"],"title":"InventoryFacilityStockStaleReason","type":"object","description":"InventoryFacilityStockStaleReason"}}}}
```

## The InventoryListingAttributeItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryListingAttributeItem":{"properties":{"valueLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"keyLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"category":{"enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"$ref":"#/components/schemas/InventoryListingAttributeItemContext"},"key":{"type":"string"},"priority":{"type":"number"},"type":{"$ref":"#/components/schemas/ArticleAttributeItemType"},"value":{"type":"string"}},"required":["key","value"],"title":"InventoryListingAttributeItem","type":"object","description":"InventoryListingAttributeItem"},"InventoryListingAttributeItemContext":{"properties":{"type":{"enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"type":"string"}},"required":["type","value"],"title":"InventoryListingAttributeItemContext","type":"object","description":"InventoryListingAttributeItemContext"},"ArticleAttributeItemType":{"description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string","xml":{"name":"ArticleAttributeItemType"},"title":"ArticleAttributeItemType"}}}}
```

## The InventoryListingAttributeItemContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryListingAttributeItemContext":{"properties":{"type":{"enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"type":"string"}},"required":["type","value"],"title":"InventoryListingAttributeItemContext","type":"object","description":"InventoryListingAttributeItemContext"}}}}
```

## The InventoryListingEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryListingEventPayload":{"properties":{"titleLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"attributes":{"items":{"$ref":"#/components/schemas/InventoryListingAttributeItem"},"type":"array"},"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]},"categoryRefs":{"items":{"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"currency":{"description":"The currency of the price as an ISO 4217 code.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"customAttributes":{"type":"object"},"facilityId":{"type":"string"},"id":{"type":"string"},"imageUrl":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"measurementUnitKey":{"type":"string"},"outOfStockBehaviour":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"outOfStockBehaviourByContexts":{"items":{"$ref":"#/components/schemas/InventoryOutOfStockBehaviourByContext"},"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/InventoryOutOfStockConfig"},"price":{"type":"number"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/InventoryRecordableAttribute"},"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/InventoryScanningRuleConfiguration"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/InventoryAvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/InventoryStockPropertyDefinition"},"type":"object"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"version":{"type":"number"},"weight":{"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/InventoryTagReference"},"type":"array"}},"required":["id","version","created","lastModified","facilityId","tenantArticleId","status"],"title":"InventoryListingEventPayload","type":"object","description":"InventoryListingEventPayload"},"InventoryListingAttributeItem":{"properties":{"valueLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"keyLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"category":{"enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"$ref":"#/components/schemas/InventoryListingAttributeItemContext"},"key":{"type":"string"},"priority":{"type":"number"},"type":{"$ref":"#/components/schemas/ArticleAttributeItemType"},"value":{"type":"string"}},"required":["key","value"],"title":"InventoryListingAttributeItem","type":"object","description":"InventoryListingAttributeItem"},"InventoryListingAttributeItemContext":{"properties":{"type":{"enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"type":"string"}},"required":["type","value"],"title":"InventoryListingAttributeItemContext","type":"object","description":"InventoryListingAttributeItemContext"},"ArticleAttributeItemType":{"description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string","xml":{"name":"ArticleAttributeItemType"},"title":"ArticleAttributeItemType"},"InventoryAvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"title":"InventoryAvailabilityTimeframe","type":"object","description":"InventoryAvailabilityTimeframe"},"InventoryOutOfStockBehaviourByContext":{"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"$ref":"#/components/schemas/InventoryOutOfStockBehaviourContext"},"type":"array"},"outOfStockBehaviour":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"outOfStockConfig":{"$ref":"#/components/schemas/InventoryOutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10.","type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"InventoryOutOfStockBehaviourByContext","type":"object","description":"InventoryOutOfStockBehaviourByContext"},"InventoryOutOfStockBehaviourContext":{"properties":{"operator":{"enum":["NOT"],"type":"string"},"type":{"enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"type":"string"},"type":"array"}},"required":["type","values"],"title":"InventoryOutOfStockBehaviourContext","type":"object","description":"InventoryOutOfStockBehaviourContext"},"InventoryOutOfStockConfig":{"properties":{"preorder":{"$ref":"#/components/schemas/InventoryOutOfStockConfigPreorder"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"InventoryOutOfStockConfig","type":"object","description":"InventoryOutOfStockConfig"},"InventoryOutOfStockConfigPreorder":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]}},"required":["availabilityTimeframe"],"title":"InventoryOutOfStockConfigPreorder","type":"object","description":"InventoryOutOfStockConfigPreorder"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"},"InventoryRecordableAttribute":{"properties":{"keyLocalized":{"type":"object"},"recordingRule":{"type":"string"},"value":{"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"InventoryRecordableAttribute","type":"object","description":"InventoryRecordableAttribute"},"InventoryScanningRuleConfiguration":{"properties":{"values":{"items":{"$ref":"#/components/schemas/InventoryScanningRuleValue"},"type":"array"}},"title":"InventoryScanningRuleConfiguration","type":"object","description":"InventoryScanningRuleConfiguration"},"InventoryScanningRuleValue":{"properties":{"priority":{"type":"number"},"scanningRuleType":{"enum":["ARTICLE","LOCATION"],"type":"string"}},"required":["priority","scanningRuleType"],"title":"InventoryScanningRuleValue","type":"object","description":"InventoryScanningRuleValue"},"InventoryAvailableUntilDefinition":{"properties":{"calculationBase":{"enum":["CREATION","EXPIRY"],"type":"string"},"modifier":{"type":"string"}},"required":["calculationBase"],"title":"InventoryAvailableUntilDefinition","type":"object","description":"InventoryAvailableUntilDefinition"},"InventoryStockPropertyDefinition":{"properties":{"inputType":{"enum":["DATE","TEXT"],"type":"string"},"required":{"type":"boolean"}},"required":["inputType","required"],"title":"InventoryStockPropertyDefinition","type":"object","description":"InventoryStockPropertyDefinition"},"InventoryTagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["id","value"],"title":"InventoryTagReference","type":"object","description":"InventoryTagReference"}}}}
```

## The InventoryOutOfStockBehaviourByContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryOutOfStockBehaviourByContext":{"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"$ref":"#/components/schemas/InventoryOutOfStockBehaviourContext"},"type":"array"},"outOfStockBehaviour":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"outOfStockConfig":{"$ref":"#/components/schemas/InventoryOutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10.","type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"InventoryOutOfStockBehaviourByContext","type":"object","description":"InventoryOutOfStockBehaviourByContext"},"InventoryOutOfStockBehaviourContext":{"properties":{"operator":{"enum":["NOT"],"type":"string"},"type":{"enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"type":"string"},"type":"array"}},"required":["type","values"],"title":"InventoryOutOfStockBehaviourContext","type":"object","description":"InventoryOutOfStockBehaviourContext"},"InventoryOutOfStockConfig":{"properties":{"preorder":{"$ref":"#/components/schemas/InventoryOutOfStockConfigPreorder"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"InventoryOutOfStockConfig","type":"object","description":"InventoryOutOfStockConfig"},"InventoryOutOfStockConfigPreorder":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]}},"required":["availabilityTimeframe"],"title":"InventoryOutOfStockConfigPreorder","type":"object","description":"InventoryOutOfStockConfigPreorder"},"InventoryAvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"title":"InventoryAvailabilityTimeframe","type":"object","description":"InventoryAvailabilityTimeframe"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"}}}}
```

## The InventoryOutOfStockBehaviourContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryOutOfStockBehaviourContext":{"properties":{"operator":{"enum":["NOT"],"type":"string"},"type":{"enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"type":"string"},"type":"array"}},"required":["type","values"],"title":"InventoryOutOfStockBehaviourContext","type":"object","description":"InventoryOutOfStockBehaviourContext"}}}}
```

## The InventoryOutOfStockConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryOutOfStockConfig":{"properties":{"preorder":{"$ref":"#/components/schemas/InventoryOutOfStockConfigPreorder"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"InventoryOutOfStockConfig","type":"object","description":"InventoryOutOfStockConfig"},"InventoryOutOfStockConfigPreorder":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]}},"required":["availabilityTimeframe"],"title":"InventoryOutOfStockConfigPreorder","type":"object","description":"InventoryOutOfStockConfigPreorder"},"InventoryAvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"title":"InventoryAvailabilityTimeframe","type":"object","description":"InventoryAvailabilityTimeframe"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"}}}}
```

## The InventoryOutOfStockConfigPreorder object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryOutOfStockConfigPreorder":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]}},"required":["availabilityTimeframe"],"title":"InventoryOutOfStockConfigPreorder","type":"object","description":"InventoryOutOfStockConfigPreorder"},"InventoryAvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"title":"InventoryAvailabilityTimeframe","type":"object","description":"InventoryAvailabilityTimeframe"}}}}
```

## The InventoryOutOfStockConfigRestock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"}}}}
```

## The InventoryRecordableAttribute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryRecordableAttribute":{"properties":{"keyLocalized":{"type":"object"},"recordingRule":{"type":"string"},"value":{"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"InventoryRecordableAttribute","type":"object","description":"InventoryRecordableAttribute"}}}}
```

## The InventoryScanningRuleConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryScanningRuleConfiguration":{"properties":{"values":{"items":{"$ref":"#/components/schemas/InventoryScanningRuleValue"},"type":"array"}},"title":"InventoryScanningRuleConfiguration","type":"object","description":"InventoryScanningRuleConfiguration"},"InventoryScanningRuleValue":{"properties":{"priority":{"type":"number"},"scanningRuleType":{"enum":["ARTICLE","LOCATION"],"type":"string"}},"required":["priority","scanningRuleType"],"title":"InventoryScanningRuleValue","type":"object","description":"InventoryScanningRuleValue"}}}}
```

## The InventoryScanningRuleValue object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryScanningRuleValue":{"properties":{"priority":{"type":"number"},"scanningRuleType":{"enum":["ARTICLE","LOCATION"],"type":"string"}},"required":["priority","scanningRuleType"],"title":"InventoryScanningRuleValue","type":"object","description":"InventoryScanningRuleValue"}}}}
```

## The InventoryStockBulkWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryStockBulkWebHookEvent":{"properties":{"payload":{"$ref":"#/components/schemas/InventoryStockWebHookEventPayload"}},"required":["payload"],"title":"InventoryStockBulkWebHookEvent","type":"object","description":"InventoryStockBulkWebHookEvent"},"InventoryStockWebHookEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InventoryStockWebHookEventPayloadItem"},"type":"array"}},"required":["items"],"title":"InventoryStockWebHookEventPayload","type":"object","description":"InventoryStockWebHookEventPayload"},"InventoryStockWebHookEventPayloadItem":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"delta":{"$ref":"#/components/schemas/InventoryStockDelta"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","delta"],"title":"InventoryStockWebHookEventPayloadItem","type":"object","description":"InventoryStockWebHookEventPayloadItem"},"InventoryStockDelta":{"properties":{"previousLocationRef":{"nullable":true,"type":"string"},"reserved":{"type":"number"},"stockCount":{"type":"number"},"value":{"type":"number"}},"required":["previousLocationRef","value","reserved","stockCount"],"title":"InventoryStockDelta","type":"object","description":"InventoryStockDelta"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The InventoryStockDelta object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryStockDelta":{"properties":{"previousLocationRef":{"nullable":true,"type":"string"},"reserved":{"type":"number"},"stockCount":{"type":"number"},"value":{"type":"number"}},"required":["previousLocationRef","value","reserved","stockCount"],"title":"InventoryStockDelta","type":"object","description":"InventoryStockDelta"}}}}
```

## The InventoryStockPropertyDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryStockPropertyDefinition":{"properties":{"inputType":{"enum":["DATE","TEXT"],"type":"string"},"required":{"type":"boolean"}},"required":["inputType","required"],"title":"InventoryStockPropertyDefinition","type":"object","description":"InventoryStockPropertyDefinition"}}}}
```

## The InventoryStockWebHookEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryStockWebHookEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InventoryStockWebHookEventPayloadItem"},"type":"array"}},"required":["items"],"title":"InventoryStockWebHookEventPayload","type":"object","description":"InventoryStockWebHookEventPayload"},"InventoryStockWebHookEventPayloadItem":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"delta":{"$ref":"#/components/schemas/InventoryStockDelta"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","delta"],"title":"InventoryStockWebHookEventPayloadItem","type":"object","description":"InventoryStockWebHookEventPayloadItem"},"InventoryStockDelta":{"properties":{"previousLocationRef":{"nullable":true,"type":"string"},"reserved":{"type":"number"},"stockCount":{"type":"number"},"value":{"type":"number"}},"required":["previousLocationRef","value","reserved","stockCount"],"title":"InventoryStockDelta","type":"object","description":"InventoryStockDelta"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The InventoryStockWebHookEventPayloadItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryStockWebHookEventPayloadItem":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"delta":{"$ref":"#/components/schemas/InventoryStockDelta"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","delta"],"title":"InventoryStockWebHookEventPayloadItem","type":"object","description":"InventoryStockWebHookEventPayloadItem"},"InventoryStockDelta":{"properties":{"previousLocationRef":{"nullable":true,"type":"string"},"reserved":{"type":"number"},"stockCount":{"type":"number"},"value":{"type":"number"}},"required":["previousLocationRef","value","reserved","stockCount"],"title":"InventoryStockDelta","type":"object","description":"InventoryStockDelta"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The InventoryTagReference object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"InventoryTagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["id","value"],"title":"InventoryTagReference","type":"object","description":"InventoryTagReference"}}}}
```

## The ItemReturn object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturn":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to 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"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"description":"references the parcel","items":{"type":"string"},"maxItems":50,"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnNotReturnableLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["id","returnFacilityRef","status","returnedLineItems"],"title":"ItemReturn","type":"object","description":"ItemReturn"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ItemReturnNotReturnableLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnNotReturnableLineItem","type":"object","description":"ItemReturnNotReturnableLineItem"}}}}
```

## The ItemReturnForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnForCreation":{"properties":{"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemForCreation"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemForCreation"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["status","returnFacilityRef","returnedLineItems"],"title":"ItemReturnForCreation","type":"object","description":"ItemReturnForCreation"},"ItemReturnLineItemForCreation":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReasonForUpsert"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRef":{"description":"id of the item return job line item that is returned","type":"string"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["itemReturnJobLineItemRef","status"],"title":"ItemReturnLineItemForCreation","type":"object","description":"ItemReturnLineItemForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReasonForUpsert":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReasonForUpsert","type":"object","description":"ItemReturnLineItemReasonForUpsert"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"}}}}
```

## The ItemReturnJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnJob":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"maxItems":100,"minItems":0,"type":"array"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"maxItems":50,"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"tenantOrderId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"title":"ItemReturnJob","type":"object","description":"ItemReturnJob"},"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"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to 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"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"description":"references the parcel","items":{"type":"string"},"maxItems":50,"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnNotReturnableLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["id","returnFacilityRef","status","returnedLineItems"],"title":"ItemReturn","type":"object","description":"ItemReturn"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ItemReturnNotReturnableLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnNotReturnableLineItem","type":"object","description":"ItemReturnNotReturnableLineItem"},"ItemReturnJobLineItem":{"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"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"},"delivered":{"description":"Quantity of this line item that has been delivered","type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"maxItems":50,"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","type":"object","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"}}}}
```

## The ItemReturnJobForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnJobForCreation":{"properties":{"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":5,"minItems":1,"type":"array"},"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"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"},"maxItems":100,"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"maxItems":50,"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"},"maxItems":100,"minItems":0,"type":"array"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"tenantOrderId":{"type":"string"}},"required":["originFacilityRefs","status","consumerAddresses","returnableLineItems"],"title":"ItemReturnJobForCreation","type":"object","description":"ItemReturnJobForCreation"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturnJobLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"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"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"maxItems":50,"type":"array"},"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","type":"object","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"}}}}
```

## The ItemReturnJobLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnJobLineItem":{"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"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"},"delivered":{"description":"Quantity of this line item that has been delivered","type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"maxItems":50,"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","type":"object","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"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"}}}}
```

## The ItemReturnJobLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The ItemReturnJobLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnJobLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"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"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"maxItems":50,"type":"array"},"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","type":"object","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"}}}}
```

## The ItemReturnJobs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnJobs":{"properties":{"itemReturnJobsWithSearchPaths":{"items":{"$ref":"#/components/schemas/ItemReturnJobWithSearchPaths"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"number"}},"title":"ItemReturnJobs","type":"object","description":"ItemReturnJobs"},"ItemReturnJobWithSearchPaths":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"maxItems":100,"minItems":0,"type":"array"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"maxItems":50,"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"searchPaths":{"items":{"type":"string"},"maxItems":500,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"tenantOrderId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"title":"ItemReturnJobWithSearchPaths","type":"object","description":"ItemReturnJobWithSearchPaths"},"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"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to 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"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"description":"references the parcel","items":{"type":"string"},"maxItems":50,"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnNotReturnableLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["id","returnFacilityRef","status","returnedLineItems"],"title":"ItemReturn","type":"object","description":"ItemReturn"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ItemReturnNotReturnableLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnNotReturnableLineItem","type":"object","description":"ItemReturnNotReturnableLineItem"},"ItemReturnJobLineItem":{"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"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"},"delivered":{"description":"Quantity of this line item that has been delivered","type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"maxItems":50,"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","type":"object","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"}}}}
```

## The ItemReturnJobWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnJobWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ItemReturnJob"}},"required":["payload"],"type":"object","title":"ItemReturnJobWebHookEvent","description":"ItemReturnJobWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ItemReturnJob":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"maxItems":100,"minItems":0,"type":"array"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"maxItems":50,"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"tenantOrderId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"title":"ItemReturnJob","type":"object","description":"ItemReturnJob"},"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"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to 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"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"description":"references the parcel","items":{"type":"string"},"maxItems":50,"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnNotReturnableLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["id","returnFacilityRef","status","returnedLineItems"],"title":"ItemReturn","type":"object","description":"ItemReturn"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ItemReturnNotReturnableLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnNotReturnableLineItem","type":"object","description":"ItemReturnNotReturnableLineItem"},"ItemReturnJobLineItem":{"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"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"},"delivered":{"description":"Quantity of this line item that has been delivered","type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"maxItems":50,"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","type":"object","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"}}}}
```

## The ItemReturnJobWithSearchPaths object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnJobWithSearchPaths":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"maxItems":100,"minItems":0,"type":"array"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"maxItems":50,"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"searchPaths":{"items":{"type":"string"},"maxItems":500,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"tenantOrderId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","version","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"title":"ItemReturnJobWithSearchPaths","type":"object","description":"ItemReturnJobWithSearchPaths"},"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"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to 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"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"description":"references the parcel","items":{"type":"string"},"maxItems":50,"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnNotReturnableLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["id","returnFacilityRef","status","returnedLineItems"],"title":"ItemReturn","type":"object","description":"ItemReturn"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ItemReturnNotReturnableLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnNotReturnableLineItem","type":"object","description":"ItemReturnNotReturnableLineItem"},"ItemReturnJobLineItem":{"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"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"},"delivered":{"description":"Quantity of this line item that has been delivered","type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"maxItems":50,"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","type":"object","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"}}}}
```

## The ItemReturnLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The ItemReturnLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnLineItemForCreation":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReasonForUpsert"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRef":{"description":"id of the item return job line item that is returned","type":"string"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["itemReturnJobLineItemRef","status"],"title":"ItemReturnLineItemForCreation","type":"object","description":"ItemReturnLineItemForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReasonForUpsert":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReasonForUpsert","type":"object","description":"ItemReturnLineItemReasonForUpsert"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"}}}}
```

## The ItemReturnLineItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnLineItemForUpdate":{"properties":{"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReasonForUpsert"},"itemReturnJobVersion":{"description":"version of the overlaying itemReturnJob","type":"integer"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"}},"required":["itemReturnJobVersion"],"title":"ItemReturnLineItemForUpdate","type":"object","description":"ItemReturnLineItemForUpdate"},"ItemReturnLineItemReasonForUpsert":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReasonForUpsert","type":"object","description":"ItemReturnLineItemReasonForUpsert"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The ItemReturnLineItemReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ItemReturnLineItemReasonForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnLineItemReasonForUpsert":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReasonForUpsert","type":"object","description":"ItemReturnLineItemReasonForUpsert"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ItemReturnNotReturnableLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnNotReturnableLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnNotReturnableLineItem","type":"object","description":"ItemReturnNotReturnableLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"}}}}
```

## The ItemReturnNotReturnableLineItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnNotReturnableLineItemForUpdate":{"properties":{"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReasonForUpsert"},"itemReturnJobVersion":{"description":"version of the overlaying itemReturnJob","type":"integer"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"}},"required":["itemReturnJobVersion"],"title":"ItemReturnNotReturnableLineItemForUpdate","type":"object","description":"ItemReturnNotReturnableLineItemForUpdate"},"ItemReturnLineItemReasonForUpsert":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReasonForUpsert","type":"object","description":"ItemReturnLineItemReasonForUpsert"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ItemReturns object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturns":{"properties":{"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturnsWithSearchPaths"},"maxItems":500,"type":"array"},"totalCount":{"description":"Total number of found entities for this query","type":"number"}},"required":["itemReturns","totalCount"],"title":"ItemReturns","type":"object","description":"ItemReturns"},"ItemReturnsWithSearchPaths":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to 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"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"description":"references the parcel","items":{"type":"string"},"maxItems":50,"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnNotReturnableLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"searchPaths":{"items":{"type":"string"},"maxItems":500,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["id","returnFacilityRef","status","returnedLineItems","searchPaths"],"title":"ItemReturnsWithSearchPaths","type":"object","description":"ItemReturnsWithSearchPaths"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ItemReturnNotReturnableLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnNotReturnableLineItem","type":"object","description":"ItemReturnNotReturnableLineItem"}}}}
```

## The ItemReturnsWithSearchPaths object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ItemReturnsWithSearchPaths":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to 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"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"description":"references the parcel","items":{"type":"string"},"maxItems":50,"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnNotReturnableLineItem"},"maxItems":100,"minItems":0,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"searchPaths":{"items":{"type":"string"},"maxItems":500,"type":"array"},"status":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT","CANCELED","OBSOLETE"],"type":"string"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["id","returnFacilityRef","status","returnedLineItems","searchPaths"],"title":"ItemReturnsWithSearchPaths","type":"object","description":"ItemReturnsWithSearchPaths"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ItemReturnNotReturnableLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnNotReturnableLineItem","type":"object","description":"ItemReturnNotReturnableLineItem"}}}}
```

## The KeyExistsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"}}}}
```

## The Label object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Label":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"facilityRef":{"description":"Reference to the connected facility","type":"string"},"id":{"description":"Unique identifier of the label","type":"string"},"labelUrl":{"description":"URL to download the label document","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["id","status","processRef","operativeProcessRef","facilityRef","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type","anonymized","created","lastModified","version"],"title":"Label","type":"object","description":"Label"},"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"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"},"maxItems":500,"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"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The LabelAdditionalDocument object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"}}}}
```

## The LabelCarrierData object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"}}}}
```

## The LabelForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LabelForCreation":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"labelUrl":{"description":"URL to download the label document","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"}},"required":["status","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type"],"title":"LabelForCreation","type":"object","description":"LabelForCreation"},"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"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"},"maxItems":500,"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"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The LabelForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LabelForUpdate":{"properties":{"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"labelUrl":{"description":"URL to download the label document","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["version"],"title":"LabelForUpdate","type":"object","description":"LabelForUpdate"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"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"},"maxItems":500,"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"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The LabelPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LabelPaginatedResult":{"properties":{"labels":{"items":{"$ref":"#/components/schemas/Label"},"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","labels"],"title":"LabelPaginatedResult","type":"object","description":"LabelPaginatedResult"},"Label":{"properties":{"additionalDocuments":{"description":"Additional documents attached to the label","items":{"$ref":"#/components/schemas/LabelAdditionalDocument"},"maxItems":20,"type":"array"},"anonymized":{"description":"Whether the label data has been anonymized","type":"boolean"},"carrierData":{"allOf":[{"$ref":"#/components/schemas/LabelCarrierData"}],"description":"Carrier and product details"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"additionalProperties":true,"description":"Custom attributes","type":"object"},"facilityRef":{"description":"Reference to the connected facility","type":"string"},"id":{"description":"Unique identifier of the label","type":"string"},"labelUrl":{"description":"URL to download the label document","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process","type":"string"},"packageRef":{"description":"Reference to the package","type":"string"},"processRef":{"description":"Reference to the fulfillment process","type":"string"},"recipientAddress":{"description":"Recipient addresses","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":10,"type":"array"},"senderAddress":{"$ref":"#/components/schemas/FacilityAddress"},"shippingInformationRef":{"description":"Reference to the shipping information","type":"string"},"shortId":{"description":"Short human-readable identifier","type":"string"},"status":{"description":"Current status of the label","enum":["WAITING_FOR_INPUT","REQUESTABLE","REQUESTED","SUCCESSFUL","FAILED","CANCELLED","OBSOLETE"],"type":"string"},"tenantLabelId":{"description":"Tenant-specific label identifier","type":"string"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"type":{"description":"Type of label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["id","status","processRef","operativeProcessRef","facilityRef","shippingInformationRef","additionalDocuments","carrierData","senderAddress","recipientAddress","type","anonymized","created","lastModified","version"],"title":"Label","type":"object","description":"Label"},"LabelAdditionalDocument":{"properties":{"nameLocalized":{"additionalProperties":true,"description":"Localized name of the document","type":"object"},"url":{"description":"URL to the additional document","type":"string"}},"required":["url","nameLocalized"],"title":"LabelAdditionalDocument","type":"object","description":"LabelAdditionalDocument"},"LabelCarrierData":{"properties":{"carrierRef":{"description":"Reference to the carrier","type":"string"},"product":{"description":"Carrier product identifier","type":"string"},"services":{"description":"Additional carrier services","items":{"$ref":"#/components/schemas/CarrierService"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"LabelCarrierData","type":"object","description":"LabelCarrierData"},"CarrierService":{"properties":{"type":{"description":"Service type identifier","type":"string"}},"required":["type"],"title":"CarrierService","type":"object","description":"CarrierService"},"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"},"maxItems":500,"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"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"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"}}}}
```

## The LabelSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LabelSearchPayload":{"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/LabelSearchQuery"},"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/LabelSort"},"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":"LabelSearchPayload","type":"object","description":"LabelSearchPayload"},"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"},"LabelSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/LabelSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/LabelSearchQuery"},"maxItems":500,"type":"array"},"processRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by processRef"},"tenantLabelId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantLabelId"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"LabelSearchQuery","type":"object","description":"LabelSearchQuery"},"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"},"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"},"LabelSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"LabelSort","type":"object","description":"LabelSort"}}}}
```

## The LabelSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LabelSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/LabelSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/LabelSearchQuery"},"maxItems":500,"type":"array"},"processRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by processRef"},"tenantLabelId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantLabelId"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"LabelSearchQuery","type":"object","description":"LabelSearchQuery"},"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"},"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"}}}}
```

## The LabelSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LabelSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"LabelSort","type":"object","description":"LabelSort"}}}}
```

## The LastDomainEntityStatusItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"}}}}
```

## The LastModuleEntityStatusItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"}}}}
```

## The LatestPickingStart object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"}}}}
```

## The LatestPickingStartForDecisionLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LatestPickingStartForDecisionLog":{"properties":{"carrierRef":{"type":"string"},"latestPickingStartDate":{"format":"date-time","type":"string"},"lpsCalculationHints":{"description":"@deprecated, use hints","items":{"type":"string"},"type":"array"},"targetTime":{"format":"date-time","type":"string"}},"type":"object","title":"LatestPickingStartForDecisionLog","description":"LatestPickingStartForDecisionLog"}}}}
```

## The LineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LineItem":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The LineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The LineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LineItemForCreation":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"title":"LineItemForCreation","type":"object","description":"LineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The LinkedConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"}}}}
```

## The LinkedServiceJobs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobs":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks"],"title":"LinkedServiceJobs","type":"object","description":"LinkedServiceJobs"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"}}}}
```

## The LinkedServiceJobsPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobsPaginatedResult":{"properties":{"linkedServiceJobs":{"items":{"$ref":"#/components/schemas/LinkedServiceJobs"},"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","linkedServiceJobs"],"title":"LinkedServiceJobsPaginatedResult","type":"object","description":"LinkedServiceJobsPaginatedResult"},"LinkedServiceJobs":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks"],"title":"LinkedServiceJobs","type":"object","description":"LinkedServiceJobs"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"},"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"}}}}
```

## The LinkedServiceJobsResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobsResult":{"properties":{"linkedServiceJobs":{"description":"List of linked service jobs matching the query","items":{"$ref":"#/components/schemas/LinkedServiceJobsWithSearchPaths"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","minimum":0,"type":"integer"}},"required":["total","linkedServiceJobs"],"title":"LinkedServiceJobsResult","type":"object","description":"LinkedServiceJobsResult"},"LinkedServiceJobsWithSearchPaths":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"searchPaths":{"description":"Search paths used for full-text search indexing of this entity","items":{"type":"string"},"maxItems":200,"type":"array"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks","searchPaths"],"title":"LinkedServiceJobsWithSearchPaths","type":"object","description":"LinkedServiceJobsWithSearchPaths"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"}}}}
```

## The LinkedServiceJobsSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobsSearchPayload":{"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/LinkedServiceJobsSearchQuery"},"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/LinkedServiceJobsSort"},"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":"LinkedServiceJobsSearchPayload","type":"object","description":"LinkedServiceJobsSearchPayload"},"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"},"LinkedServiceJobsSearchQuery":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by additionalInformation"},"and":{"items":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"maxItems":500,"type":"array"},"articleTitles":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by articleTitles"},"channel":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by channel"},"consumerName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerName"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoiceAddress":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by invoiceAddress"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"linkedServiceJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by linkedServiceJobRef"},"or":{"items":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"maxItems":500,"type":"array"},"serviceName":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by serviceName"},"shippingAddress":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shippingAddress"},"status":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"},"usersModificationHistory":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryListFilter"}],"description":"Nested list search by usersModificationHistory"}},"title":"LinkedServiceJobsSearchQuery","type":"object","description":"LinkedServiceJobsSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"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"},"LinkedServiceJobsUsersModificationHistoryListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"LinkedServiceJobsUsersModificationHistoryListFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryListFilter"},"LinkedServiceJobsUsersModificationHistoryFilter":{"properties":{"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"LinkedServiceJobsUsersModificationHistoryFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryFilter"},"LinkedServiceJobsSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"LinkedServiceJobsSort","type":"object","description":"LinkedServiceJobsSort"}}}}
```

## The LinkedServiceJobsSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobsSearchQuery":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by additionalInformation"},"and":{"items":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"maxItems":500,"type":"array"},"articleTitles":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by articleTitles"},"channel":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by channel"},"consumerName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerName"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoiceAddress":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by invoiceAddress"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"linkedServiceJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by linkedServiceJobRef"},"or":{"items":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"maxItems":500,"type":"array"},"serviceName":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by serviceName"},"shippingAddress":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shippingAddress"},"status":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"},"usersModificationHistory":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryListFilter"}],"description":"Nested list search by usersModificationHistory"}},"title":"LinkedServiceJobsSearchQuery","type":"object","description":"LinkedServiceJobsSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"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"},"LinkedServiceJobsUsersModificationHistoryListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"LinkedServiceJobsUsersModificationHistoryListFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryListFilter"},"LinkedServiceJobsUsersModificationHistoryFilter":{"properties":{"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"LinkedServiceJobsUsersModificationHistoryFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryFilter"}}}}
```

## The LinkedServiceJobsSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobsSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"LinkedServiceJobsSort","type":"object","description":"LinkedServiceJobsSort"}}}}
```

## The LinkedServiceJobsUsersModificationHistoryFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobsUsersModificationHistoryFilter":{"properties":{"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"LinkedServiceJobsUsersModificationHistoryFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryFilter"},"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"}}}}
```

## The LinkedServiceJobsUsersModificationHistoryListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobsUsersModificationHistoryListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"LinkedServiceJobsUsersModificationHistoryListFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryListFilter"},"LinkedServiceJobsUsersModificationHistoryFilter":{"properties":{"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"LinkedServiceJobsUsersModificationHistoryFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryFilter"},"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"}}}}
```

## The LinkedServiceJobsWithSearchPaths object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LinkedServiceJobsWithSearchPaths":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"searchPaths":{"description":"Search paths used for full-text search indexing of this entity","items":{"type":"string"},"maxItems":200,"type":"array"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks","searchPaths"],"title":"LinkedServiceJobsWithSearchPaths","type":"object","description":"LinkedServiceJobsWithSearchPaths"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"}}}}
```

## The Listing object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"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"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"}}}}
```

## The ListingAttributeItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The ListingAvailabilityAnalysis object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingAvailabilityAnalysis":{"properties":{"availableForPicking":{"description":"The quantity available for picking.","type":"number"},"facilityId":{"description":"The ID of the facility.","type":"string"},"outOfStockBehaviour":{"description":"The calculated out of stock behavior for the underlying order.","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"tenantArticleId":{"description":"The tenant article ID.","type":"string"}},"required":["facilityId","tenantArticleId","availableForPicking","outOfStockBehaviour"],"title":"ListingAvailabilityAnalysis","type":"object","description":"ListingAvailabilityAnalysis"}}}}
```

## The ListingAvailabilityTimeframeFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingAvailabilityTimeframeFilter":{"properties":{"start":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by start"}},"title":"ListingAvailabilityTimeframeFilter","type":"object","description":"ListingAvailabilityTimeframeFilter"},"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"}}}}
```

## The ListingBulkOperationResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingBulkOperationResult":{"properties":{"listing":{"$ref":"#/components/schemas/Listing"},"status":{"$ref":"#/components/schemas/BulkOperationResultStatus"}},"required":["listing","status"],"type":"object","title":"ListingBulkOperationResult","description":"ListingBulkOperationResult"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"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"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"BulkOperationResultStatus":{"enum":["UPDATED","UNCHANGED","CREATED","FAILED"],"type":"string","title":"BulkOperationResultStatus","description":"BulkOperationResultStatus"}}}}
```

## The ListingBulkUpsertPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingBulkUpsertPayload":{"properties":{"listings":{"description":"List of listings to be upserted in bulk. Number of entries times selectors must not exceed 25.","items":{"discriminator":{"mapping":{"MULTI_SELECTOR":"#/components/schemas/ListingForBulkUpsertBySelector","SINGLE_FACILITY":"#/components/schemas/ListingForBulkUpsertByFacility"},"propertyName":"targetingStrategy"},"oneOf":[{"$ref":"#/components/schemas/ListingForBulkUpsertBySelector"},{"$ref":"#/components/schemas/ListingForBulkUpsertByFacility"}]},"minItems":1,"type":"array"}},"required":["listings"],"title":"ListingBulkUpsertPayload","type":"object","description":"ListingBulkUpsertPayload"},"ListingForBulkUpsertBySelector":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","nullable":true,"type":"string"},"customAttributes":{"additionalProperties":true,"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext2"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"allOf":[{"$ref":"#/components/schemas/OutOfStockConfig2"}],"description":"The outOfStockConfig is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>"},"price":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","type":"number"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"selector":{"description":"Facility selectors for bulk operations. Add one or more selectors to specify the facilities for the listings.","items":{"$ref":"#/components/schemas/ListingFacilitySelector"},"minItems":1,"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"description":"Key-value pairs for stock properties of the requested items. Must be a subset of the listings defined stockProperties","type":"object"},"targetingStrategy":{"description":"Targeting strategy for this bulk upsert entry - determines how target facilities are specified.","enum":["MULTI_SELECTOR","SINGLE_FACILITY"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId","title","targetingStrategy","selector"],"title":"ListingForBulkUpsertBySelector","type":"object","description":"ListingForBulkUpsertBySelector"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext2":{"properties":{"context":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext"},"maxItems":5,"minItems":1,"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig2"},"priority":{"type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"OutOfStockBehaviourByContext2","type":"object","description":"OutOfStockBehaviourByContext2"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig2":{"properties":{"preorder":{"$ref":"#/components/schemas/OutOfStockConfigPreorder2"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"OutOfStockConfig2","type":"object","description":"OutOfStockConfig2"},"OutOfStockConfigPreorder2":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/AvailabilityTimeframe2"}]}},"required":["availabilityTimeframe"],"title":"OutOfStockConfigPreorder2","type":"object","description":"OutOfStockConfigPreorder2"},"AvailabilityTimeframe2":{"properties":{"start":{"type":"string"}},"required":["start"],"title":"AvailabilityTimeframe2","type":"object","description":"AvailabilityTimeframe2"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"ListingFacilitySelector":{"properties":{"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"version":{"description":"Optional version of the facility. Must be provided for existing facilities. Leave empty for new facilities.","type":"number"}},"required":["facility"],"title":"ListingFacilitySelector","type":"object","description":"ListingFacilitySelector"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ListingForBulkUpsertByFacility":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","nullable":true,"type":"string"},"customAttributes":{"additionalProperties":true,"description":"Attributes that can be added to the listing. 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"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext2"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"allOf":[{"$ref":"#/components/schemas/OutOfStockConfig2"}],"description":"The outOfStockConfig is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>"},"price":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","type":"number"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"description":"Key-value pairs for stock properties of the requested items. Must be a subset of the listings defined stockProperties","type":"object"},"targetingStrategy":{"description":"Targeting strategy for this bulk upsert entry - determines how target facilities are specified.","enum":["MULTI_SELECTOR","SINGLE_FACILITY"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"version":{"description":"Optional version of the facility. Must be provided for existing facilities.","type":"number"},"weight":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId","title","targetingStrategy","facility"],"title":"ListingForBulkUpsertByFacility","type":"object","description":"ListingForBulkUpsertByFacility"}}}}
```

## The ListingBulkUpsertResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingBulkUpsertResponse":{"properties":{"listings":{"description":"Listings upsert operations that were successfully upserted.","items":{"$ref":"#/components/schemas/ListingBulkUpsertSuccess"},"type":"array"},"summary":{"allOf":[{"$ref":"#/components/schemas/BulkUpsertSummary"}],"description":"Summary of the operations."}},"required":["summary","listings"],"title":"ListingBulkUpsertResponse","type":"object","description":"ListingBulkUpsertResponse"},"ListingBulkUpsertSuccess":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/Listing"}],"description":"The resulting entity."},"status":{"description":"Indicates whether the operation created or updated the entity.","enum":["CREATED","UPDATED","UNCHANGED"],"type":"string"}},"required":["status","result"],"title":"ListingBulkUpsertSuccess","type":"object","description":"ListingBulkUpsertSuccess"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"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"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"BulkUpsertSummary":{"properties":{"created":{"description":"The number of operations that led to an insertion","type":"number"},"unchanged":{"description":"The number of operations that led to no change","type":"number"},"updated":{"description":"The number of operations that led to an update","type":"number"}},"required":["created","updated","unchanged"],"title":"BulkUpsertSummary","type":"object","description":"BulkUpsertSummary"}}}}
```

## The ListingBulkUpsertSuccess object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingBulkUpsertSuccess":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/Listing"}],"description":"The resulting entity."},"status":{"description":"Indicates whether the operation created or updated the entity.","enum":["CREATED","UPDATED","UNCHANGED"],"type":"string"}},"required":["status","result"],"title":"ListingBulkUpsertSuccess","type":"object","description":"ListingBulkUpsertSuccess"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"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"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"}}}}
```

## The ListingBulkWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingBulkWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ListingWebHookEventPayload"}},"required":["payload"],"title":"ListingBulkWebHookEvent","type":"object","description":"ListingBulkWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ListingWebHookEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InventoryListingEventPayload"},"type":"array"}},"required":["items"],"title":"ListingWebHookEventPayload","type":"object","description":"ListingWebHookEventPayload"},"InventoryListingEventPayload":{"properties":{"titleLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"attributes":{"items":{"$ref":"#/components/schemas/InventoryListingAttributeItem"},"type":"array"},"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]},"categoryRefs":{"items":{"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"currency":{"description":"The currency of the price as an ISO 4217 code.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"customAttributes":{"type":"object"},"facilityId":{"type":"string"},"id":{"type":"string"},"imageUrl":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"measurementUnitKey":{"type":"string"},"outOfStockBehaviour":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"outOfStockBehaviourByContexts":{"items":{"$ref":"#/components/schemas/InventoryOutOfStockBehaviourByContext"},"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/InventoryOutOfStockConfig"},"price":{"type":"number"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/InventoryRecordableAttribute"},"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/InventoryScanningRuleConfiguration"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/InventoryAvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/InventoryStockPropertyDefinition"},"type":"object"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"version":{"type":"number"},"weight":{"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/InventoryTagReference"},"type":"array"}},"required":["id","version","created","lastModified","facilityId","tenantArticleId","status"],"title":"InventoryListingEventPayload","type":"object","description":"InventoryListingEventPayload"},"InventoryListingAttributeItem":{"properties":{"valueLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"keyLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"category":{"enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"$ref":"#/components/schemas/InventoryListingAttributeItemContext"},"key":{"type":"string"},"priority":{"type":"number"},"type":{"$ref":"#/components/schemas/ArticleAttributeItemType"},"value":{"type":"string"}},"required":["key","value"],"title":"InventoryListingAttributeItem","type":"object","description":"InventoryListingAttributeItem"},"InventoryListingAttributeItemContext":{"properties":{"type":{"enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"type":"string"}},"required":["type","value"],"title":"InventoryListingAttributeItemContext","type":"object","description":"InventoryListingAttributeItemContext"},"ArticleAttributeItemType":{"description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string","xml":{"name":"ArticleAttributeItemType"},"title":"ArticleAttributeItemType"},"InventoryAvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"title":"InventoryAvailabilityTimeframe","type":"object","description":"InventoryAvailabilityTimeframe"},"InventoryOutOfStockBehaviourByContext":{"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"$ref":"#/components/schemas/InventoryOutOfStockBehaviourContext"},"type":"array"},"outOfStockBehaviour":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"outOfStockConfig":{"$ref":"#/components/schemas/InventoryOutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10.","type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"InventoryOutOfStockBehaviourByContext","type":"object","description":"InventoryOutOfStockBehaviourByContext"},"InventoryOutOfStockBehaviourContext":{"properties":{"operator":{"enum":["NOT"],"type":"string"},"type":{"enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"type":"string"},"type":"array"}},"required":["type","values"],"title":"InventoryOutOfStockBehaviourContext","type":"object","description":"InventoryOutOfStockBehaviourContext"},"InventoryOutOfStockConfig":{"properties":{"preorder":{"$ref":"#/components/schemas/InventoryOutOfStockConfigPreorder"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"InventoryOutOfStockConfig","type":"object","description":"InventoryOutOfStockConfig"},"InventoryOutOfStockConfigPreorder":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]}},"required":["availabilityTimeframe"],"title":"InventoryOutOfStockConfigPreorder","type":"object","description":"InventoryOutOfStockConfigPreorder"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"},"InventoryRecordableAttribute":{"properties":{"keyLocalized":{"type":"object"},"recordingRule":{"type":"string"},"value":{"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"InventoryRecordableAttribute","type":"object","description":"InventoryRecordableAttribute"},"InventoryScanningRuleConfiguration":{"properties":{"values":{"items":{"$ref":"#/components/schemas/InventoryScanningRuleValue"},"type":"array"}},"title":"InventoryScanningRuleConfiguration","type":"object","description":"InventoryScanningRuleConfiguration"},"InventoryScanningRuleValue":{"properties":{"priority":{"type":"number"},"scanningRuleType":{"enum":["ARTICLE","LOCATION"],"type":"string"}},"required":["priority","scanningRuleType"],"title":"InventoryScanningRuleValue","type":"object","description":"InventoryScanningRuleValue"},"InventoryAvailableUntilDefinition":{"properties":{"calculationBase":{"enum":["CREATION","EXPIRY"],"type":"string"},"modifier":{"type":"string"}},"required":["calculationBase"],"title":"InventoryAvailableUntilDefinition","type":"object","description":"InventoryAvailableUntilDefinition"},"InventoryStockPropertyDefinition":{"properties":{"inputType":{"enum":["DATE","TEXT"],"type":"string"},"required":{"type":"boolean"}},"required":["inputType","required"],"title":"InventoryStockPropertyDefinition","type":"object","description":"InventoryStockPropertyDefinition"},"InventoryTagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["id","value"],"title":"InventoryTagReference","type":"object","description":"InventoryTagReference"}}}}
```

## The ListingFacilitySelector object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingFacilitySelector":{"properties":{"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"version":{"description":"Optional version of the facility. Must be provided for existing facilities. Leave empty for new facilities.","type":"number"}},"required":["facility"],"title":"ListingFacilitySelector","type":"object","description":"ListingFacilitySelector"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"}}}}
```

## The ListingForBulkUpsertByFacility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingForBulkUpsertByFacility":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","nullable":true,"type":"string"},"customAttributes":{"additionalProperties":true,"description":"Attributes that can be added to the listing. 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"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext2"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"allOf":[{"$ref":"#/components/schemas/OutOfStockConfig2"}],"description":"The outOfStockConfig is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>"},"price":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","type":"number"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"description":"Key-value pairs for stock properties of the requested items. Must be a subset of the listings defined stockProperties","type":"object"},"targetingStrategy":{"description":"Targeting strategy for this bulk upsert entry - determines how target facilities are specified.","enum":["MULTI_SELECTOR","SINGLE_FACILITY"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"version":{"description":"Optional version of the facility. Must be provided for existing facilities.","type":"number"},"weight":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId","title","targetingStrategy","facility"],"title":"ListingForBulkUpsertByFacility","type":"object","description":"ListingForBulkUpsertByFacility"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext2":{"properties":{"context":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext"},"maxItems":5,"minItems":1,"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig2"},"priority":{"type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"OutOfStockBehaviourByContext2","type":"object","description":"OutOfStockBehaviourByContext2"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig2":{"properties":{"preorder":{"$ref":"#/components/schemas/OutOfStockConfigPreorder2"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"OutOfStockConfig2","type":"object","description":"OutOfStockConfig2"},"OutOfStockConfigPreorder2":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/AvailabilityTimeframe2"}]}},"required":["availabilityTimeframe"],"title":"OutOfStockConfigPreorder2","type":"object","description":"OutOfStockConfigPreorder2"},"AvailabilityTimeframe2":{"properties":{"start":{"type":"string"}},"required":["start"],"title":"AvailabilityTimeframe2","type":"object","description":"AvailabilityTimeframe2"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ListingForBulkUpsertBySelector object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingForBulkUpsertBySelector":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","nullable":true,"type":"string"},"customAttributes":{"additionalProperties":true,"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext2"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"allOf":[{"$ref":"#/components/schemas/OutOfStockConfig2"}],"description":"The outOfStockConfig is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>"},"price":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","type":"number"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"selector":{"description":"Facility selectors for bulk operations. Add one or more selectors to specify the facilities for the listings.","items":{"$ref":"#/components/schemas/ListingFacilitySelector"},"minItems":1,"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"description":"Key-value pairs for stock properties of the requested items. Must be a subset of the listings defined stockProperties","type":"object"},"targetingStrategy":{"description":"Targeting strategy for this bulk upsert entry - determines how target facilities are specified.","enum":["MULTI_SELECTOR","SINGLE_FACILITY"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId","title","targetingStrategy","selector"],"title":"ListingForBulkUpsertBySelector","type":"object","description":"ListingForBulkUpsertBySelector"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext2":{"properties":{"context":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext"},"maxItems":5,"minItems":1,"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig2"},"priority":{"type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"OutOfStockBehaviourByContext2","type":"object","description":"OutOfStockBehaviourByContext2"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig2":{"properties":{"preorder":{"$ref":"#/components/schemas/OutOfStockConfigPreorder2"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"OutOfStockConfig2","type":"object","description":"OutOfStockConfig2"},"OutOfStockConfigPreorder2":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/AvailabilityTimeframe2"}]}},"required":["availabilityTimeframe"],"title":"OutOfStockConfigPreorder2","type":"object","description":"OutOfStockConfigPreorder2"},"AvailabilityTimeframe2":{"properties":{"start":{"type":"string"}},"required":["start"],"title":"AvailabilityTimeframe2","type":"object","description":"AvailabilityTimeframe2"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"ListingFacilitySelector":{"properties":{"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"version":{"description":"Optional version of the facility. Must be provided for existing facilities. Leave empty for new facilities.","type":"number"}},"required":["facility"],"title":"ListingFacilitySelector","type":"object","description":"ListingFacilitySelector"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ListingForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ListingForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingForReplacement":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"}],"properties":{"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"format":"int64","type":"integer"}},"type":"object","xml":{"name":"ListingForReplacement"},"title":"ListingForReplacement","description":"ListingForReplacement"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ListingLegal object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"}}}}
```

## The ListingOutOfStockBehaviourEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingOutOfStockBehaviourEnumFilter":{"properties":{"eq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"in":{"description":"Search by outOfStockBehaviour","items":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"}},"title":"ListingOutOfStockBehaviourEnumFilter","type":"object","description":"ListingOutOfStockBehaviourEnumFilter"}}}}
```

## The ListingPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingPaginatedResult":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/Listing"},"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","listings"],"title":"ListingPaginatedResult","type":"object","description":"ListingPaginatedResult"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"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"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"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"}}}}
```

## The ListingPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingPatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyListing"},"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":"ListingPatchActions"},"title":"ListingPatchActions","description":"ListingPatchActions"},"ModifyListing":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyListing', because you want to modify a listing","enum":["ModifyListing"],"type":"string"},"attributes":{"description":"The attributes of this listing","items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"nullable":true,"type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"status":{"description":"The status indicates if a listing is available or not","enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"nullable":true,"type":"object"},"subtitle":{"description":"a subtitle describing the article","type":"string"},"title":{"description":"a title describing the article","type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyListing"},"title":"ModifyListing","description":"ModifyListing"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ListingRecordableAttribute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ListingRecordableAttributeForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ListingSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingSearchPayload":{"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/ListingSearchQuery"},"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/ListingSort"},"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":"ListingSearchPayload","type":"object","description":"ListingSearchPayload"},"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"},"ListingSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ListingSearchQuery"},"maxItems":500,"type":"array"},"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/ListingAvailabilityTimeframeFilter"}],"description":"Nested search by availabilityTimeframe"},"categoryRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by categoryRefs"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"measurementUnitKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by measurementUnitKey"},"or":{"items":{"$ref":"#/components/schemas/ListingSearchQuery"},"maxItems":500,"type":"array"},"outOfStockBehaviour":{"allOf":[{"$ref":"#/components/schemas/ListingOutOfStockBehaviourEnumFilter"}],"description":"Search by outOfStockBehaviour"},"price":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by price"},"status":{"allOf":[{"$ref":"#/components/schemas/ListingStatusEnumEnumFilter"}],"description":"Search by status"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"weight":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by weight"},"tags":{"allOf":[{"$ref":"#/components/schemas/ListingTagsListFilter"}],"description":"Nested list search by tags"}},"title":"ListingSearchQuery","type":"object","description":"ListingSearchQuery"},"ListingAvailabilityTimeframeFilter":{"properties":{"start":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by start"}},"title":"ListingAvailabilityTimeframeFilter","type":"object","description":"ListingAvailabilityTimeframeFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"ListingOutOfStockBehaviourEnumFilter":{"properties":{"eq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"in":{"description":"Search by outOfStockBehaviour","items":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"}},"title":"ListingOutOfStockBehaviourEnumFilter","type":"object","description":"ListingOutOfStockBehaviourEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ListingStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"}},"title":"ListingStatusEnumEnumFilter","type":"object","description":"ListingStatusEnumEnumFilter"},"ListingTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ListingTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ListingTagsListFilter","type":"object","description":"ListingTagsListFilter"},"ListingTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ListingTagsFilter","type":"object","description":"ListingTagsFilter"},"ListingSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"tenantArticleId":{"enum":["ASC","DESC"],"type":"string"}},"title":"ListingSort","type":"object","description":"ListingSort"}}}}
```

## The ListingSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ListingSearchQuery"},"maxItems":500,"type":"array"},"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/ListingAvailabilityTimeframeFilter"}],"description":"Nested search by availabilityTimeframe"},"categoryRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by categoryRefs"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"measurementUnitKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by measurementUnitKey"},"or":{"items":{"$ref":"#/components/schemas/ListingSearchQuery"},"maxItems":500,"type":"array"},"outOfStockBehaviour":{"allOf":[{"$ref":"#/components/schemas/ListingOutOfStockBehaviourEnumFilter"}],"description":"Search by outOfStockBehaviour"},"price":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by price"},"status":{"allOf":[{"$ref":"#/components/schemas/ListingStatusEnumEnumFilter"}],"description":"Search by status"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"weight":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by weight"},"tags":{"allOf":[{"$ref":"#/components/schemas/ListingTagsListFilter"}],"description":"Nested list search by tags"}},"title":"ListingSearchQuery","type":"object","description":"ListingSearchQuery"},"ListingAvailabilityTimeframeFilter":{"properties":{"start":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by start"}},"title":"ListingAvailabilityTimeframeFilter","type":"object","description":"ListingAvailabilityTimeframeFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"ListingOutOfStockBehaviourEnumFilter":{"properties":{"eq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"in":{"description":"Search by outOfStockBehaviour","items":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"}},"title":"ListingOutOfStockBehaviourEnumFilter","type":"object","description":"ListingOutOfStockBehaviourEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ListingStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"}},"title":"ListingStatusEnumEnumFilter","type":"object","description":"ListingStatusEnumEnumFilter"},"ListingTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ListingTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ListingTagsListFilter","type":"object","description":"ListingTagsListFilter"},"ListingTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ListingTagsFilter","type":"object","description":"ListingTagsFilter"}}}}
```

## The ListingsForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingsForCreation":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/ListingForCreation"},"minItems":1,"type":"array"}},"required":["listings"],"type":"object","xml":{"name":"ListingsForCreation"},"title":"ListingsForCreation","description":"ListingsForCreation"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ListingsForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingsForReplacement":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/ListingForReplacement"},"maxItems":500,"minItems":1,"type":"array"}},"required":["listings"],"type":"object","xml":{"name":"ListingsForReplacement"},"title":"ListingsForReplacement","description":"ListingsForReplacement"},"ListingForReplacement":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"}],"properties":{"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"format":"int64","type":"integer"}},"type":"object","xml":{"name":"ListingForReplacement"},"title":"ListingForReplacement","description":"ListingForReplacement"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ListingSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"tenantArticleId":{"enum":["ASC","DESC"],"type":"string"}},"title":"ListingSort","type":"object","description":"ListingSort"}}}}
```

## The ListingStatusEnumEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"}},"title":"ListingStatusEnumEnumFilter","type":"object","description":"ListingStatusEnumEnumFilter"}}}}
```

## The ListingTagsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ListingTagsFilter","type":"object","description":"ListingTagsFilter"},"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"}}}}
```

## The ListingTagsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ListingTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ListingTagsListFilter","type":"object","description":"ListingTagsListFilter"},"ListingTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ListingTagsFilter","type":"object","description":"ListingTagsFilter"},"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"}}}}
```

## The ListingWebHookEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ListingWebHookEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InventoryListingEventPayload"},"type":"array"}},"required":["items"],"title":"ListingWebHookEventPayload","type":"object","description":"ListingWebHookEventPayload"},"InventoryListingEventPayload":{"properties":{"titleLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"attributes":{"items":{"$ref":"#/components/schemas/InventoryListingAttributeItem"},"type":"array"},"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]},"categoryRefs":{"items":{"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"currency":{"description":"The currency of the price as an ISO 4217 code.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"customAttributes":{"type":"object"},"facilityId":{"type":"string"},"id":{"type":"string"},"imageUrl":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"measurementUnitKey":{"type":"string"},"outOfStockBehaviour":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"outOfStockBehaviourByContexts":{"items":{"$ref":"#/components/schemas/InventoryOutOfStockBehaviourByContext"},"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/InventoryOutOfStockConfig"},"price":{"type":"number"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/InventoryRecordableAttribute"},"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/InventoryScanningRuleConfiguration"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/InventoryAvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/InventoryStockPropertyDefinition"},"type":"object"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"version":{"type":"number"},"weight":{"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/InventoryTagReference"},"type":"array"}},"required":["id","version","created","lastModified","facilityId","tenantArticleId","status"],"title":"InventoryListingEventPayload","type":"object","description":"InventoryListingEventPayload"},"InventoryListingAttributeItem":{"properties":{"valueLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"keyLocalized":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","type":"object"},"category":{"enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"$ref":"#/components/schemas/InventoryListingAttributeItemContext"},"key":{"type":"string"},"priority":{"type":"number"},"type":{"$ref":"#/components/schemas/ArticleAttributeItemType"},"value":{"type":"string"}},"required":["key","value"],"title":"InventoryListingAttributeItem","type":"object","description":"InventoryListingAttributeItem"},"InventoryListingAttributeItemContext":{"properties":{"type":{"enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"type":"string"}},"required":["type","value"],"title":"InventoryListingAttributeItemContext","type":"object","description":"InventoryListingAttributeItemContext"},"ArticleAttributeItemType":{"description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string","xml":{"name":"ArticleAttributeItemType"},"title":"ArticleAttributeItemType"},"InventoryAvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"title":"InventoryAvailabilityTimeframe","type":"object","description":"InventoryAvailabilityTimeframe"},"InventoryOutOfStockBehaviourByContext":{"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"$ref":"#/components/schemas/InventoryOutOfStockBehaviourContext"},"type":"array"},"outOfStockBehaviour":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"outOfStockConfig":{"$ref":"#/components/schemas/InventoryOutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10.","type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"InventoryOutOfStockBehaviourByContext","type":"object","description":"InventoryOutOfStockBehaviourByContext"},"InventoryOutOfStockBehaviourContext":{"properties":{"operator":{"enum":["NOT"],"type":"string"},"type":{"enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"type":"string"},"type":"array"}},"required":["type","values"],"title":"InventoryOutOfStockBehaviourContext","type":"object","description":"InventoryOutOfStockBehaviourContext"},"InventoryOutOfStockConfig":{"properties":{"preorder":{"$ref":"#/components/schemas/InventoryOutOfStockConfigPreorder"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"InventoryOutOfStockConfig","type":"object","description":"InventoryOutOfStockConfig"},"InventoryOutOfStockConfigPreorder":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/InventoryAvailabilityTimeframe"}]}},"required":["availabilityTimeframe"],"title":"InventoryOutOfStockConfigPreorder","type":"object","description":"InventoryOutOfStockConfigPreorder"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"},"InventoryRecordableAttribute":{"properties":{"keyLocalized":{"type":"object"},"recordingRule":{"type":"string"},"value":{"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"InventoryRecordableAttribute","type":"object","description":"InventoryRecordableAttribute"},"InventoryScanningRuleConfiguration":{"properties":{"values":{"items":{"$ref":"#/components/schemas/InventoryScanningRuleValue"},"type":"array"}},"title":"InventoryScanningRuleConfiguration","type":"object","description":"InventoryScanningRuleConfiguration"},"InventoryScanningRuleValue":{"properties":{"priority":{"type":"number"},"scanningRuleType":{"enum":["ARTICLE","LOCATION"],"type":"string"}},"required":["priority","scanningRuleType"],"title":"InventoryScanningRuleValue","type":"object","description":"InventoryScanningRuleValue"},"InventoryAvailableUntilDefinition":{"properties":{"calculationBase":{"enum":["CREATION","EXPIRY"],"type":"string"},"modifier":{"type":"string"}},"required":["calculationBase"],"title":"InventoryAvailableUntilDefinition","type":"object","description":"InventoryAvailableUntilDefinition"},"InventoryStockPropertyDefinition":{"properties":{"inputType":{"enum":["DATE","TEXT"],"type":"string"},"required":{"type":"boolean"}},"required":["inputType","required"],"title":"InventoryStockPropertyDefinition","type":"object","description":"InventoryStockPropertyDefinition"},"InventoryTagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["id","value"],"title":"InventoryTagReference","type":"object","description":"InventoryTagReference"}}}}
```

## The LoadUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnit":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"description":"List of codes","items":{"type":"string"},"maxItems":100,"type":"array"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/LoadUnitDimensions"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"type":"string"},"id":{"description":"Unique identifier for the load unit","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"loadUnitLineItems":{"items":{"$ref":"#/components/schemas/LoadUnitLineItem"},"maxItems":100,"type":"array"},"loadUnitTypeRef":{"deprecated":true,"description":"Use operativeContainerTypeRef instead.","type":"string"},"name":{"type":"string"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process","minLength":1,"type":"string"},"pickJobRefs":{"description":"List of corresponding pickjob Ids","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array","uniqueItems":true},"stackRef":{"description":"the reference to the stackRef this loadUnit is part of","type":"string"},"status":{"default":"AVAILABLE","description":"The status of the load unit. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a load unit is created, it is automatically set to AVAILABLE. When a load unit is deleted, it is automatically set to OBSOLETE.","enum":["AVAILABLE","OBSOLETE"],"type":"string"},"storageLocationRef":{"description":"the reference to the storage location this load unit as been placed into","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the loadunit can handle.","minimum":1,"type":"number"}},"required":["id","lastModified","created","version","facilityRef","pickJobRefs","nameLocalized","status"],"title":"LoadUnit","type":"object","description":"LoadUnit"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"LoadUnitDimensions":{"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"title":"LoadUnitDimensions","type":"object","description":"LoadUnitDimensions"},"LoadUnitLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"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"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Unique identifier for the line item","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article"],"title":"LoadUnitLineItem","type":"object","description":"LoadUnitLineItem"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The LoadUnitAssignmentConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitAssignmentConfiguration":{"description":"Who do the load units need to be assigned in pickJob (SingleOrderPick) and pickRun (MultiOrderPick)","properties":{"pickJob":{"$ref":"#/components/schemas/LoadUnitAssignmentType"},"pickRun":{"$ref":"#/components/schemas/LoadUnitAssignmentType"}},"required":["pickJob","pickRun"],"type":"object","title":"LoadUnitAssignmentConfiguration"},"LoadUnitAssignmentType":{"description":"Where do the load unit needs to be assigned?","enum":["INACTIVE","AT_START","AT_END","DURING_PICKING"],"type":"string","title":"LoadUnitAssignmentType"}}}}
```

## The LoadUnitAssignmentType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitAssignmentType":{"description":"Where do the load unit needs to be assigned?","enum":["INACTIVE","AT_START","AT_END","DURING_PICKING"],"type":"string","title":"LoadUnitAssignmentType"}}}}
```

## The LoadUnitConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"maxCount":{"default":20,"description":"Max creatable count of load units per load unit type","type":"integer"}},"type":"object","title":"LoadUnitConfiguration","description":"LoadUnitConfiguration"},"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"}}}}
```

## The LoadUnitDimensions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitDimensions":{"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"title":"LoadUnitDimensions","type":"object","description":"LoadUnitDimensions"}}}}
```

## The LoadUnitForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitForCreation":{"properties":{"codes":{"description":"List of codes","items":{"type":"string"},"maxItems":100,"type":"array"},"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"},"loadUnitLineItems":{"items":{"$ref":"#/components/schemas/LoadUnitLineItemForCreation"},"maxItems":100,"type":"array"},"loadUnitTypeRef":{"deprecated":true,"description":"Use operativeContainerTypeRef instead.","type":"string"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"},"pickJobRefs":{"description":"List of corresponding pickjob Ids","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"stackRef":{"description":"the reference to the stackRef this loadUnit is part of","type":"string"},"storageLocationRef":{"description":"the reference to the storage location this load unit as been placed into","type":"string"}},"required":["pickJobRefs"],"title":"LoadUnitForCreation","type":"object","description":"LoadUnitForCreation"},"LoadUnitLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"customAttributes":{"type":"object"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article"],"title":"LoadUnitLineItemForCreation","type":"object","description":"LoadUnitLineItemForCreation"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The LoadUnitLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"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"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Unique identifier for the line item","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article"],"title":"LoadUnitLineItem","type":"object","description":"LoadUnitLineItem"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The LoadUnitLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The LoadUnitLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"customAttributes":{"type":"object"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article"],"title":"LoadUnitLineItemForCreation","type":"object","description":"LoadUnitLineItemForCreation"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The LoadUnitLineItemUpdateRecordableAttributesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitLineItemUpdateRecordableAttributesActionParameter":{"properties":{"name":{"description":"Update the recordable attributes of the line items of a load unit","type":"string"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForUpdate"},"maxItems":100,"type":"array"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","recordableAttributes"],"title":"LoadUnitLineItemUpdateRecordableAttributesActionParameter","type":"object","description":"LoadUnitLineItemUpdateRecordableAttributesActionParameter"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The LoadUnitPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitPatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ReplaceLoadUnitLineItems"},"maxItems":100,"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["actions","version"],"title":"LoadUnitPatchActions","type":"object","description":"LoadUnitPatchActions"},"ReplaceLoadUnitLineItems":{"properties":{"action":{"description":"Use value 'ReplaceLoadUnitLineItems', because you want to replace load unit line items","enum":["ReplaceLoadUnitLineItems"],"type":"string"},"loadUnitLineItems":{"items":{"$ref":"#/components/schemas/LoadUnitLineItem"},"maxItems":100,"type":"array"}},"required":["action","loadUnitLineItems"],"title":"ReplaceLoadUnitLineItems","type":"object","description":"ReplaceLoadUnitLineItems"},"LoadUnitLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"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"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Unique identifier for the line item","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article"],"title":"LoadUnitLineItem","type":"object","description":"LoadUnitLineItem"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The LoadUnits object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnits":{"properties":{"loadUnits":{"description":"found load units matching the search parameters","items":{"$ref":"#/components/schemas/LoadUnit"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"required":["loadUnits","total"],"title":"LoadUnits","type":"object","description":"LoadUnits"},"LoadUnit":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"description":"List of codes","items":{"type":"string"},"maxItems":100,"type":"array"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/LoadUnitDimensions"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"type":"string"},"id":{"description":"Unique identifier for the load unit","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"loadUnitLineItems":{"items":{"$ref":"#/components/schemas/LoadUnitLineItem"},"maxItems":100,"type":"array"},"loadUnitTypeRef":{"deprecated":true,"description":"Use operativeContainerTypeRef instead.","type":"string"},"name":{"type":"string"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process","minLength":1,"type":"string"},"pickJobRefs":{"description":"List of corresponding pickjob Ids","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array","uniqueItems":true},"stackRef":{"description":"the reference to the stackRef this loadUnit is part of","type":"string"},"status":{"default":"AVAILABLE","description":"The status of the load unit. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a load unit is created, it is automatically set to AVAILABLE. When a load unit is deleted, it is automatically set to OBSOLETE.","enum":["AVAILABLE","OBSOLETE"],"type":"string"},"storageLocationRef":{"description":"the reference to the storage location this load unit as been placed into","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the loadunit can handle.","minimum":1,"type":"number"}},"required":["id","lastModified","created","version","facilityRef","pickJobRefs","nameLocalized","status"],"title":"LoadUnit","type":"object","description":"LoadUnit"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"LoadUnitDimensions":{"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"title":"LoadUnitDimensions","type":"object","description":"LoadUnitDimensions"},"LoadUnitLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"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"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Unique identifier for the line item","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article"],"title":"LoadUnitLineItem","type":"object","description":"LoadUnitLineItem"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The LoadUnitsForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitsForCreation":{"properties":{"loadUnits":{"items":{"$ref":"#/components/schemas/LoadUnitForCreation"},"maxItems":100,"minItems":1,"type":"array"}},"required":["loadUnits"],"title":"LoadUnitsForCreation","type":"object","description":"LoadUnitsForCreation"},"LoadUnitForCreation":{"properties":{"codes":{"description":"List of codes","items":{"type":"string"},"maxItems":100,"type":"array"},"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"},"loadUnitLineItems":{"items":{"$ref":"#/components/schemas/LoadUnitLineItemForCreation"},"maxItems":100,"type":"array"},"loadUnitTypeRef":{"deprecated":true,"description":"Use operativeContainerTypeRef instead.","type":"string"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"},"pickJobRefs":{"description":"List of corresponding pickjob Ids","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"stackRef":{"description":"the reference to the stackRef this loadUnit is part of","type":"string"},"storageLocationRef":{"description":"the reference to the storage location this load unit as been placed into","type":"string"}},"required":["pickJobRefs"],"title":"LoadUnitForCreation","type":"object","description":"LoadUnitForCreation"},"LoadUnitLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"customAttributes":{"type":"object"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article"],"title":"LoadUnitLineItemForCreation","type":"object","description":"LoadUnitLineItemForCreation"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The LoadUnitType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitType":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/LoadUnitDimensions"},"iconUrl":{"type":"string"},"id":{"type":"string"},"lastModified":{"description":"Creation timestamp","format":"date-time","type":"string"},"name":{"type":"string"},"priority":{"description":"This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes","format":"int64","maximum":10000,"minimum":1,"type":"integer"},"version":{"type":"number"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the loadunit can handle.","minimum":1,"type":"number"}},"required":["id","version","nameLocalized"],"title":"LoadUnitType","type":"object","description":"LoadUnitType"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"LoadUnitDimensions":{"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"title":"LoadUnitDimensions","type":"object","description":"LoadUnitDimensions"}}}}
```

## The LoadUnitTypeForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitTypeForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"dimensions":{"$ref":"#/components/schemas/LoadUnitDimensions"},"icon":{"$ref":"#/components/schemas/NamedFile"},"priority":{"description":"This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes","format":"int64","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the loadunit can handle.","minimum":1,"type":"number"}},"required":["nameLocalized"],"title":"LoadUnitTypeForCreation","type":"object","description":"LoadUnitTypeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"LoadUnitDimensions":{"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"title":"LoadUnitDimensions","type":"object","description":"LoadUnitDimensions"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"}}}}
```

## The LoadUnitTypePatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LoadUnitTypePatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyLoadUnitType"},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","actions"],"title":"LoadUnitTypePatchActions","type":"object","description":"LoadUnitTypePatchActions"},"ModifyLoadUnitType":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value, because you want to modify a LoadUnitType","enum":["ModifyLoadUnitType"],"type":"string"},"dimensions":{"$ref":"#/components/schemas/LoadUnitDimensions"},"priority":{"description":"This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes","format":"int64","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the loadunit can handle.","minimum":1,"type":"number"}},"required":["action"],"title":"ModifyLoadUnitType","type":"object","description":"ModifyLoadUnitType"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"LoadUnitDimensions":{"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"title":"LoadUnitDimensions","type":"object","description":"LoadUnitDimensions"}}}}
```

## The LocaleConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LocaleConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"countryLanguageMapping":{"$ref":"#/components/schemas/CountryLanguageMapping"},"id":{"type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["locale"],"type":"object","title":"LocaleConfiguration","description":"LocaleConfiguration"},"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"},"CountryLanguageMapping":{"additionalProperties":{"type":"string"},"type":"object","title":"CountryLanguageMapping","description":"CountryLanguageMapping"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"}}}}
```

## The LocaleString object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The LocaleStringConstrained object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"}}}}
```

## The LocalizedAvailableDecisionReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LocalizedAvailableDecisionReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"context":{"items":{"$ref":"#/components/schemas/DecisionReasonContext"},"maxItems":10,"minItems":1,"type":"array"},"reason":{"description":"Translated value from  reasonLocalized","type":"string"}},"required":["reason","reasonLocalized"],"title":"LocalizedAvailableDecisionReason","type":"object","description":"LocalizedAvailableDecisionReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"DecisionReasonContext":{"properties":{"type":{"enum":["ITEM_RETURN_LINE_ITEM_STATUS"],"type":"string"},"values":{"items":{"enum":["ACCEPTED","REJECTED","WAITING_FOR_INPUT"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"title":"DecisionReasonContext","type":"object","description":"DecisionReasonContext"}}}}
```

## The LocalizedAvailableItemCondition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LocalizedAvailableItemCondition":{"properties":{"conditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"condition":{"description":"translated conditionsLocalized","type":"string"}},"required":["condition","conditionLocalized"],"title":"LocalizedAvailableItemCondition","type":"object","description":"LocalizedAvailableItemCondition"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The LocalizedAvailableReturnReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LocalizedAvailableReturnReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"identifier":{"description":"Small identifier to be displayed and printed. Allowed values are 1-99 and A-Z. Needs to be unique respecting all other reasons. If not set, an ascending will be chosen automatically","type":"string"},"reason":{"description":"translated reasonLocalized","type":"string"}},"required":["identifier","reason","reasonLocalized"],"title":"LocalizedAvailableReturnReason","type":"object","description":"LocalizedAvailableReturnReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The LocalizedReturnConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LocalizedReturnConfiguration":{"properties":{"active":{"default":true,"deprecated":true,"description":"Enable or disable legacy returns. Use returnTypeConfiguration instead","type":"boolean"},"allowTriggerRefund":{"default":false,"description":"If true, a refund can be triggered. If false, the endpoints to trigger a refund are disabled.","type":"boolean"},"availableDecisionReasons":{"items":{"$ref":"#/components/schemas/LocalizedAvailableDecisionReason"},"type":"array"},"availableItemConditions":{"items":{"$ref":"#/components/schemas/LocalizedAvailableItemCondition"},"type":"array"},"availableReturnReasons":{"items":{"$ref":"#/components/schemas/LocalizedAvailableReturnReason"},"type":"array"},"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"},"returnTypeConfiguration":{"$ref":"#/components/schemas/ReturnTypeConfiguration"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["active","version"],"title":"LocalizedReturnConfiguration","type":"object","description":"LocalizedReturnConfiguration"},"LocalizedAvailableDecisionReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"context":{"items":{"$ref":"#/components/schemas/DecisionReasonContext"},"maxItems":10,"minItems":1,"type":"array"},"reason":{"description":"Translated value from  reasonLocalized","type":"string"}},"required":["reason","reasonLocalized"],"title":"LocalizedAvailableDecisionReason","type":"object","description":"LocalizedAvailableDecisionReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"DecisionReasonContext":{"properties":{"type":{"enum":["ITEM_RETURN_LINE_ITEM_STATUS"],"type":"string"},"values":{"items":{"enum":["ACCEPTED","REJECTED","WAITING_FOR_INPUT"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"title":"DecisionReasonContext","type":"object","description":"DecisionReasonContext"},"LocalizedAvailableItemCondition":{"properties":{"conditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"condition":{"description":"translated conditionsLocalized","type":"string"}},"required":["condition","conditionLocalized"],"title":"LocalizedAvailableItemCondition","type":"object","description":"LocalizedAvailableItemCondition"},"LocalizedAvailableReturnReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"identifier":{"description":"Small identifier to be displayed and printed. Allowed values are 1-99 and A-Z. Needs to be unique respecting all other reasons. If not set, an ascending will be chosen automatically","type":"string"},"reason":{"description":"translated reasonLocalized","type":"string"}},"required":["identifier","reason","reasonLocalized"],"title":"LocalizedAvailableReturnReason","type":"object","description":"LocalizedAvailableReturnReason"},"ReturnTypeConfiguration":{"properties":{"type":{"enum":["RETURN","ITEM_RETURN"],"type":"string"}},"required":["type"],"title":"ReturnTypeConfiguration","type":"object","description":"ReturnTypeConfiguration"}}}}
```

## The LocalizedStringSearchFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LocalizedStringSearchFilter":{"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":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"}}}}
```

## The Location object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The LongGoodsDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LongGoodsDetails":{"properties":{"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"loadCarrierHeight":{"description":"The height in millimeters of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"loadCarrierWeight":{"description":"The tare weight in grams of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"maxGirth":{"description":"The maximum girth in millimeters of the packagingUnit.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxLength":{"description":"The maximum length in millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"type":"string"},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","packagingPricingDetails"],"title":"LongGoodsDetails","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />LongGoodsDetails"},"PackagingPricingDetails":{"properties":{"costCoefficient":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitCostCoefficient"}],"description":"Cost coefficient for two-man handling"},"pricing":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricingByZone"},"maxItems":500,"type":"array"},"surchargesPerPackagingUnits":{"description":"The surcharge applied per packagingUnit.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackagingUnitDetailRelativeSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"}]},"maxItems":500,"type":"array"}},"required":["pricing"],"title":"PackagingPricingDetails","type":"object","description":"PackagingPricingDetails"},"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"},"PackagingUnitPricingBasis":{"properties":{"pricingQuantities":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","items":{"$ref":"#/components/schemas/PackagingUnitPricingQuantity"},"maxItems":3,"type":"array"},"pricingUnit":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingUnit"}],"description":"The unit the pricing quantities are converted to and priced in."}},"required":["pricingUnit","pricingQuantities"],"title":"PackagingUnitPricingBasis","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />PackagingUnitPricingBasis"},"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"},"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"}}}}
```

## The LookupAttributeDefinitions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"}}}}
```

## The LookupRecord object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecord":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"created":{"description":"The date when the record was created.","format":"date-time","type":"string"},"id":{"type":"string"},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemStripped"},"type":"array"},"lastModified":{"description":"The date when the record was last modified.","format":"date-time","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["id","version","attributeDefinitions","items"],"title":"LookupRecord","type":"object","description":"LookupRecord"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemStripped":{"properties":{"id":{"description":"Unique identifier for the lookup record item.","type":"string"},"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values","id"],"title":"LookupRecordItemStripped","type":"object","description":"LookupRecordItemStripped"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"}}}}
```

## The LookupRecordForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordForCreation":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemForCreation"},"type":"array"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"}},"required":["attributeDefinitions","items"],"title":"LookupRecordForCreation","type":"object","description":"LookupRecordForCreation"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemForCreation":{"properties":{"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values"],"title":"LookupRecordItemForCreation","type":"object","description":"LookupRecordItemForCreation"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"}}}}
```

## The LookupRecordForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordForUpdate":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemForCreation"},"type":"array"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["version","attributeDefinitions","items"],"title":"LookupRecordForUpdate","type":"object","description":"LookupRecordForUpdate"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemForCreation":{"properties":{"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values"],"title":"LookupRecordItemForCreation","type":"object","description":"LookupRecordItemForCreation"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"}}}}
```

## The LookupRecordItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItem":{"properties":{"id":{"type":"string"},"recordRef":{"description":"Reference to the parent lookup record.","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"values":{"$ref":"#/components/schemas/LookupRecordItemValue","description":"Array of attribute-value pairs for the lookup record item.","items":{"type":"string"}}},"required":["recordRef","values","id"],"title":"LookupRecordItem","type":"object","description":"LookupRecordItem"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"}}}}
```

## The LookupRecordItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItemForCreation":{"properties":{"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values"],"title":"LookupRecordItemForCreation","type":"object","description":"LookupRecordItemForCreation"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"}}}}
```

## The LookupRecordItemPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItemPaginatedResult":{"properties":{"lookupRecordItems":{"items":{"$ref":"#/components/schemas/LookupRecordItem"},"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","lookupRecordItems"],"title":"LookupRecordItemPaginatedResult","type":"object","description":"LookupRecordItemPaginatedResult"},"LookupRecordItem":{"properties":{"id":{"type":"string"},"recordRef":{"description":"Reference to the parent lookup record.","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"values":{"$ref":"#/components/schemas/LookupRecordItemValue","description":"Array of attribute-value pairs for the lookup record item.","items":{"type":"string"}}},"required":["recordRef","values","id"],"title":"LookupRecordItem","type":"object","description":"LookupRecordItem"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"},"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"}}}}
```

## The LookupRecordItemSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItemSearchPayload":{"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/LookupRecordItemSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"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":"LookupRecordItemSearchPayload","type":"object","description":"LookupRecordItemSearchPayload"},"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"},"LookupRecordItemSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"maxItems":500,"type":"array"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"maxItems":500,"type":"array"},"recordRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recordRef"},"tenantRecordId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantRecordId"},"values":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesListFilter"}],"description":"Nested list search by values"}},"title":"LookupRecordItemSearchQuery","type":"object","description":"LookupRecordItemSearchQuery"},"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"},"LookupRecordItemValuesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"LookupRecordItemValuesListFilter","type":"object","description":"LookupRecordItemValuesListFilter"},"LookupRecordItemValuesFilter":{"properties":{"attributeId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeId"},"attributeValue":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeValue"}},"title":"LookupRecordItemValuesFilter","type":"object","description":"LookupRecordItemValuesFilter"}}}}
```

## The LookupRecordItemSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItemSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"maxItems":500,"type":"array"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"maxItems":500,"type":"array"},"recordRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recordRef"},"tenantRecordId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantRecordId"},"values":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesListFilter"}],"description":"Nested list search by values"}},"title":"LookupRecordItemSearchQuery","type":"object","description":"LookupRecordItemSearchQuery"},"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"},"LookupRecordItemValuesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"LookupRecordItemValuesListFilter","type":"object","description":"LookupRecordItemValuesListFilter"},"LookupRecordItemValuesFilter":{"properties":{"attributeId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeId"},"attributeValue":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeValue"}},"title":"LookupRecordItemValuesFilter","type":"object","description":"LookupRecordItemValuesFilter"}}}}
```

## The LookupRecordItemStripped object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItemStripped":{"properties":{"id":{"description":"Unique identifier for the lookup record item.","type":"string"},"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values","id"],"title":"LookupRecordItemStripped","type":"object","description":"LookupRecordItemStripped"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"}}}}
```

## The LookupRecordItemValue object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"}}}}
```

## The LookupRecordItemValuesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItemValuesFilter":{"properties":{"attributeId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeId"},"attributeValue":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeValue"}},"title":"LookupRecordItemValuesFilter","type":"object","description":"LookupRecordItemValuesFilter"},"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"}}}}
```

## The LookupRecordItemValuesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecordItemValuesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"LookupRecordItemValuesListFilter","type":"object","description":"LookupRecordItemValuesListFilter"},"LookupRecordItemValuesFilter":{"properties":{"attributeId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeId"},"attributeValue":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeValue"}},"title":"LookupRecordItemValuesFilter","type":"object","description":"LookupRecordItemValuesFilter"},"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"}}}}
```

## The ManagedFacility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"}}}}
```

## The ManagedFacilityForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"}}}}
```

## The ManagedFacilityForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ManagedFacilityForModification":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"description":"Indicates that configured capacity limits for picking times are considered","nullable":true,"type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"nullable":true,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"nullable":true,"type":"array"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"nullable":true,"type":"array"},"contact":{"allOf":[{"$ref":"#/components/schemas/FacilityContact"}],"nullable":true,"type":"object"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"fulfillmentProcessBuffer":{"description":"Duration in minutes until an order is processed","minimum":0,"nullable":true,"type":"integer"},"locationType":{"allOf":[{"$ref":"#/components/schemas/FacilityLocationType"}],"nullable":true,"type":"string"},"name":{"type":"string"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"nullable":true,"type":"array"},"pickingTimes":{"allOf":[{"$ref":"#/components/schemas/PickingTimes"}],"nullable":true,"type":"object"},"scanningRule":{"allOf":[{"$ref":"#/components/schemas/ScanningRuleConfiguration"}],"nullable":true,"type":"object"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"nullable":true,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","nullable":true,"type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"nullable":true,"type":"array"}},"required":["type","version"],"type":"object","xml":{"name":"ManagedFacilityForModification"},"title":"ManagedFacilityForModification","description":"ManagedFacilityForModification"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ManagedFacilityForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ManagedFacilityForReplacement":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"name":{"type":"string"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"discriminator":{"propertyName":"type"},"required":["version","type","status","name","address","locationType","fulfillmentProcessBuffer","capacityEnabled"],"type":"object","xml":{"name":"ManagedFacilityForReplacement"},"title":"ManagedFacilityForReplacement","description":"ManagedFacilityForReplacement"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The MandatoryLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"}}}}
```

## The MandatoryLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The MandatoryShippingArticleAttribute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The MandatoryShippingAttribute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The MandatoryShippingItemAttribute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ManualRerouteConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ManualRerouteConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"deprecated":true,"description":"@deprecated This config property is deprecated since 26/02/24. Use GlobalManualRerouteConfiguration instead.","properties":{"active":{"type":"boolean"},"id":{"type":"string"}},"required":["active"],"type":"object","title":"ManualRerouteConfiguration"},"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"}}}}
```

## The MeasurementUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MeasurementUnit":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MeasurementUnitForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"abbreviation":{"description":"Translated abbreviation of the measurement unit","type":"string"},"id":{"type":"string"},"name":{"description":"Translated name of the measurement unit","type":"string"}},"required":["id"],"type":"object","title":"MeasurementUnit","description":"MeasurementUnit"},"MeasurementUnitForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"abbreviationLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Abbreviation of the unit. Maximum 4 chars long."},"key":{"description":"Descriptor for the measurement unit","type":"string"},"requiresMeasurement":{"description":"Indicates that the given unit need to be measured.","type":"boolean"}},"required":["nameLocalized","abbreviationLocalized","key"],"type":"object","title":"MeasurementUnitForCreation","description":"MeasurementUnitForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The MeasurementUnitForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MeasurementUnitForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"abbreviationLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Abbreviation of the unit. Maximum 4 chars long."},"key":{"description":"Descriptor for the measurement unit","type":"string"},"requiresMeasurement":{"description":"Indicates that the given unit need to be measured.","type":"boolean"}},"required":["nameLocalized","abbreviationLocalized","key"],"type":"object","title":"MeasurementUnitForCreation","description":"MeasurementUnitForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The MeasurementUnits object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MeasurementUnits":{"properties":{"measurementUnits":{"items":{"$ref":"#/components/schemas/MeasurementUnit"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"MeasurementUnits","description":"MeasurementUnits"},"MeasurementUnit":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MeasurementUnitForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"abbreviation":{"description":"Translated abbreviation of the measurement unit","type":"string"},"id":{"type":"string"},"name":{"description":"Translated name of the measurement unit","type":"string"}},"required":["id"],"type":"object","title":"MeasurementUnit","description":"MeasurementUnit"},"MeasurementUnitForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"abbreviationLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Abbreviation of the unit. Maximum 4 chars long."},"key":{"description":"Descriptor for the measurement unit","type":"string"},"requiresMeasurement":{"description":"Indicates that the given unit need to be measured.","type":"boolean"}},"required":["nameLocalized","abbreviationLocalized","key"],"type":"object","title":"MeasurementUnitForCreation","description":"MeasurementUnitForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The MeasurementValidation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"}}}}
```

## The MergeDocumentsDocument object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MergeDocumentsDocument":{"properties":{"documentId":{"description":"id of the document from the passed document set","type":"string"},"documentsSetRef":{"description":"document set of the passed document","type":"string"}},"required":["documentId","documentsSetRef"],"title":"MergeDocumentsDocument","type":"object","description":"MergeDocumentsDocument"}}}}
```

## The MergeDocumentsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MergeDocumentsParameter":{"properties":{"documents":{"description":"Documents that should be merged during this operation","items":{"$ref":"#/components/schemas/MergeDocumentsDocument"},"maxItems":50,"minItems":1,"type":"array"}},"required":["documents"],"title":"MergeDocumentsParameter","type":"object","description":"MergeDocumentsParameter"},"MergeDocumentsDocument":{"properties":{"documentId":{"description":"id of the document from the passed document set","type":"string"},"documentsSetRef":{"description":"document set of the passed document","type":"string"}},"required":["documentId","documentsSetRef"],"title":"MergeDocumentsDocument","type":"object","description":"MergeDocumentsDocument"}}}}
```

## The MissingHandoverJobLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MissingHandoverJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MissingHandoverJobLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"MissingHandoverJobLineItem","description":"MissingHandoverJobLineItem"},"MissingHandoverJobLineItemForCreation":{"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 is missing","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"MissingHandoverJobLineItemForCreation","description":"MissingHandoverJobLineItemForCreation"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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":{"allOf":[{"$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"}}}}
```

## The MissingHandoverJobLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MissingHandoverJobLineItemForCreation":{"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 is missing","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"MissingHandoverJobLineItemForCreation","description":"MissingHandoverJobLineItemForCreation"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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":{"allOf":[{"$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"}}}}
```

## The ModifyAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyAddress":{"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"}},"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"street":{"pattern":"^.+$","type":"string"}},"type":"object","title":"ModifyAddress","description":"ModifyAddress"},"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"}}}}
```

## The ModifyCarrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyCarrier":{"properties":{"action":{"description":"Use value 'ModifyCarrier', because you want to modify a carrier","enum":["ModifyCarrier"],"type":"string"},"credentials":{"allOf":[{"$ref":"#/components/schemas/AbstractModifyCarrierCredentials"}],"description":"Credentials for the carrier"},"defaultParcelHeightInCm":{"default":10,"description":"Default height in cm","minimum":1,"type":"number"},"defaultParcelLengthInCm":{"default":25,"description":"Default length in cm","minimum":1,"type":"number"},"defaultParcelWeightInGram":{"default":1000,"description":"Default weight for a parcel in gram","minimum":1,"type":"number"},"defaultParcelWidthInCm":{"default":35,"description":"Default width in cm","minimum":1,"type":"number"},"deliveryType":{"description":"Provided delivery of this CEP","enum":["SAMEDAY","DELIVERY"],"type":"string"},"lifecycle":{"description":"Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet.","enum":["GA","BETA","ALPHA"],"type":"string"},"logoUrl":{"description":"URL of the carrier logo","minLength":1,"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"parcelLabelClassifications":{"description":"Parcel label classifications for this carrier","items":{"$ref":"#/components/schemas/ParcelLabelClassificationForCreation"},"type":"array"},"productValueNeeded":{"description":"Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)","type":"boolean"},"status":{"description":"It is taken into consideration for all carriers","enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["action"],"title":"ModifyCarrier","type":"object","description":"ModifyCarrier"},"AbstractModifyCarrierCredentials":{"properties":{"key":{"description":"The key identifying the carrier credentials type","type":"string"}},"required":["key"],"title":"AbstractModifyCarrierCredentials","type":"object","description":"AbstractModifyCarrierCredentials"},"ParcelLabelClassificationForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassificationForCreation","type":"object","description":"ParcelLabelClassificationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"}}}}
```

## The ModifyCustomServiceAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyCustomServiceAction":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyCustomService', because you want to modify a custom service","enum":["ModifyCustomService"],"type":"string"},"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"imageRefs":{"description":"List of linked images for this custom service","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing a service job of this custom service","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items of the custom service are returnable after the custom service has been executed","type":"boolean"},"status":{"description":"New status to set for the custom service","enum":["ENABLED","DISABLED","INACTIVE","ACTIVE"],"type":"string"},"tenantCustomServiceId":{"description":"Tenant specific ID of the custom service to be modified","minLength":1,"type":"string"}},"required":["action"],"title":"ModifyCustomServiceAction","type":"object","description":"ModifyCustomServiceAction"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ModifyFacility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyFacility":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyFacility', because you want to modify a facility","enum":["ModifyFacility"],"type":"string"},"address":{"$ref":"#/components/schemas/ModifyFacilityAddress"},"capacityEnabled":{"type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"fulfillmentProcessBuffer":{"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"properties":{"type":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"required":["type"],"type":"object"},"type":"array"},"status":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyFacility"},"title":"ModifyFacility","description":"ModifyFacility"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"ModifyFacilityAddress":{"allOf":[{"$ref":"#/components/schemas/ModifyAddress"},{"type":"object"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object"},"type":"array"}},"type":"object"}],"title":"ModifyFacilityAddress","description":"ModifyFacilityAddress"},"ModifyAddress":{"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"}},"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"street":{"pattern":"^.+$","type":"string"}},"type":"object","title":"ModifyAddress","description":"ModifyAddress"},"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"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ModifyFacilityAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyFacilityAddress":{"allOf":[{"$ref":"#/components/schemas/ModifyAddress"},{"type":"object"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object"},"type":"array"}},"type":"object"}],"title":"ModifyFacilityAddress","description":"ModifyFacilityAddress"},"ModifyAddress":{"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"}},"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"street":{"pattern":"^.+$","type":"string"}},"type":"object","title":"ModifyAddress","description":"ModifyAddress"},"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"}}}}
```

## The ModifyFeature object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyFeature":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyFeature', because you want to modify a Feature","enum":["ModifyFeature"],"type":"string"},"status":{"$ref":"#/components/schemas/FeatureStatus","description":"The state of the feature we want to change."}},"required":["action","status"],"type":"object"}],"xml":{"name":"ModifyFeature"},"title":"ModifyFeature","description":"ModifyFeature"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"FeatureStatus":{"enum":["enabled","inactive","disabled"],"type":"string","title":"FeatureStatus","description":"FeatureStatus"}}}}
```

## The ModifyFenceAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyFenceAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyFence', because you want to modify a fence.","enum":["ModifyFence"],"type":"string"},"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"id":{"type":"string"}},"required":["action","id"],"type":"object"}],"description":"Action to Modify a Fence.","title":"ModifyFenceAction","xml":{"name":"ModifyFenceAction"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"}}}}
```

## The ModifyGlobalRoutingConfigurationAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyGlobalRoutingConfigurationAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyGlobalRoutingConfiguration', because you want to modify global routing configuration.","enum":["ModifyGlobalRoutingConfiguration"],"type":"string"},"defaultPrice":{"default":10,"description":"Default price which is used if no price exists in order or listings","type":"number"},"fallbackFacilityConfiguration":{"$ref":"#/components/schemas/FallbackFacilityConfigurationForPatch"},"manualRerouteConfiguration":{"$ref":"#/components/schemas/GlobalManualRerouteConfiguration"},"routingTimeout":{"default":8,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Default amount of hours after which a routing plan is marked not routable. This field is deprecated in favour of stopRoutingAttemptsAfterTime","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"Default amount of time in ISO 8601 duration format after which a routing plan is marked not routable. The duration need to be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"@deprecated use RoutingStrategy configuration actions instead 'Action to Modify the Global Routing Configuration.'","title":"ModifyGlobalRoutingConfigurationAction"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"FallbackFacilityConfigurationForPatch":{"deprecated":true,"description":"@deprecated use RoutingStrategyFallbackFacilityConfiguration instead","properties":{"active":{"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"title":"FallbackFacilityConfigurationForPatch"},"GlobalManualRerouteConfiguration":{"description":"Allows reroutes to be triggered manually via api.","properties":{"active":{"type":"boolean"}},"required":["active"],"type":"object","title":"GlobalManualRerouteConfiguration"}}}}
```

## The ModifyHandoverjob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyHandoverjob":{"additionalProperties":false,"description":"Action to modify a HandoverJob.","properties":{"action":{"$ref":"#/components/schemas/ModifyHandoverjobActionEnum"},"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"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"}},"required":["action"],"title":"ModifyHandoverjobAction","type":"object","xml":{"name":"ModifyHandoverjob"}},"ModifyHandoverjobActionEnum":{"enum":["ModifyHandoverjob"],"type":"string","title":"ModifyHandoverjobActionEnum","description":"ModifyHandoverjobActionEnum"},"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"},"maxItems":500,"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"}}}}
```

## The ModifyHandoverjobActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyHandoverjobActionEnum":{"enum":["ModifyHandoverjob"],"type":"string","title":"ModifyHandoverjobActionEnum","description":"ModifyHandoverjobActionEnum"}}}}
```

## The ModifyListing object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyListing":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyListing', because you want to modify a listing","enum":["ModifyListing"],"type":"string"},"attributes":{"description":"The attributes of this listing","items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. 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"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"nullable":true,"type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"status":{"description":"The status indicates if a listing is available or not","enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"nullable":true,"type":"object"},"subtitle":{"description":"a subtitle describing the article","type":"string"},"title":{"description":"a title describing the article","type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyListing"},"title":"ModifyListing","description":"ModifyListing"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ModifyListingReactivationAfter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyListingReactivationAfter":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyListingReactivationAfter', if you want to modify the listingReactivationAfter of a facility","enum":["ModifyListingReactivationAfter"],"type":"string"},"listingReactivationAfter":{"properties":{"active":{"default":true,"description":"The disabling of listings is enabled or disabled.","type":"boolean"},"value":{"default":24,"description":"Time in hours that has to pass for a deactivated listing (e.g. due to manual deactivation or as a result of a shortpick ) to be become active again.","type":"number"}},"type":"object"}},"required":["action"],"type":"object"}],"description":"Action to modify the reactivationAfter property of a Listing.","title":"ModifyListingReactivationAfterAction","xml":{"name":"ModifyListingReactivationAfter"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The ModifyLoadUnitType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyLoadUnitType":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value, because you want to modify a LoadUnitType","enum":["ModifyLoadUnitType"],"type":"string"},"dimensions":{"$ref":"#/components/schemas/LoadUnitDimensions"},"priority":{"description":"This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes","format":"int64","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the loadunit can handle.","minimum":1,"type":"number"}},"required":["action"],"title":"ModifyLoadUnitType","type":"object","description":"ModifyLoadUnitType"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"LoadUnitDimensions":{"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"title":"LoadUnitDimensions","type":"object","description":"LoadUnitDimensions"}}}}
```

## The ModifyMeAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyMeAction":{"properties":{"action":{"description":"The type of action to perform","enum":["ModifyMe"],"type":"string"},"firstname":{"description":"The new firstname of the user","type":"string"},"lastname":{"description":"The new lastname of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["action"],"title":"ModifyMeAction","type":"object","description":"ModifyMeAction"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"}}}}
```

## The ModifyMyCredentialsAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyMyCredentialsAction":{"properties":{"action":{"description":"The type of action to perform","enum":["ModifyCredentials"],"type":"string"},"currentPassword":{"description":"Current password for verification (required)","type":"string"},"email":{"description":"New email address (optional)","type":"string"},"password":{"description":"New password (optional)","type":"string"}},"required":["currentPassword","action"],"title":"ModifyMyCredentialsAction","type":"object","description":"ModifyMyCredentialsAction"}}}}
```

## The ModifyOrderSplitAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyOrderSplitAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyOrderSplit', because you want to modify the configuration for the an order split.","enum":["ModifyOrderSplit"],"type":"string"},"active":{"default":false,"type":"boolean"},"activeForSameDay":{"default":false,"type":"boolean"},"fixedCountConfiguration":{"$ref":"#/components/schemas/FixedCountConfiguration"},"orderSplitType":{"$ref":"#/components/schemas/OrderSplitType"},"shouldUseWaitingRoomForPreBackOrderItems":{"default":false,"type":"boolean"}},"required":["action"],"type":"object"}],"description":"Action to Modify the Order Split Configuration.","title":"ModifyOrderSplitAction","xml":{"name":"ModifyOrderSplitAction"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"FixedCountConfiguration":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration of fixed count split.","properties":{"maxSplitCount":{"description":"This setting defines how often an order split might be performed to fulfill the order.","minimum":1,"type":"number"}},"required":["maxSplitCount"],"type":"object","title":"FixedCountConfiguration"},"OrderSplitType":{"description":"The type of order split","enum":["FIXED_COUNT"],"type":"string","xml":{"name":"OrderSplitType"},"title":"OrderSplitType"}}}}
```

## The ModifyPackingContainerType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPackingContainerType":{"additionalProperties":false,"description":"Action to a modify the type of a packing container.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyPackingContainerType', because you want to modify a PackingContainerType","enum":["ModifyPackingContainerType"],"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"priority":{"description":"This value gives the priority in the respective packingContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order PackingContainerTypes.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["action"],"title":"ModifyPackingContainerType","type":"object","xml":{"name":"ModifyPackingContainerType"}},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"}}}}
```

## The ModifyPackingContainerTypeIcon object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPackingContainerTypeIcon":{"additionalProperties":false,"description":"Action to a modify the type icon of a packing container.","properties":{"action":{"description":"Use value 'ModifyPackingContainerTypeIcon', because you want to modify a PackingContainerTypes icon","enum":["ModifyPackingContainerTypeIcon"],"type":"string"},"content":{"description":"Content of the icon as base64 string","type":"string"},"name":{"description":"icons filename","type":"string"}},"required":["action","name","content"],"title":"ModifyPackingContainerTypeIcon","type":"object","xml":{"name":"ModifyPackingContainerTypeIcon"}}}}}
```

## The ModifyPackJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPackJob":{"additionalProperties":false,"description":"Action to modify a PackJob","properties":{"action":{"description":"Use value 'ModifyPackJob', because you want to modify a packjob","enum":["ModifyPackJob"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the line item. 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/PackJobStatus"}},"required":["action"],"title":"ModifyPackJob","type":"object","xml":{"name":"ModifyPackJob"}},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"}}}}
```

## The ModifyPackLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPackLineItem":{"additionalProperties":false,"description":"Action to modify a PackLineItem of a PackJob","properties":{"action":{"description":"Use value 'ModifyPackLineItem', because you want to modify a packjobs lineItem","enum":["ModifyPackLineItem"],"type":"string"},"id":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this packline. Can't be more than picked before.","format":"int64","minimum":0,"type":"integer"}},"required":["action","id"],"title":"ModifyPackLineItem","type":"object","xml":{"name":"ModifyPackLineItem"}}}}}
```

## The ModifyParcel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyParcel":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyParcel', because you want to modify a Parcel","enum":["ModifyParcel"],"type":"string"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Only changable on status OPEN or FAILED of the existing Parcel","nullable":true,"type":"string"},"customAttributes":{"type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency","nullable":true,"type":"number"},"result":{"$ref":"#/components/schemas/ParcelResult"},"services":{"$ref":"#/components/schemas/ParcelServices"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantParcelId":{"type":"string"}},"required":["action"],"type":"object"}],"description":"Modify Parcel Action.","title":"ModifyParcelAction","xml":{"name":"ModifyParcel"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"}}}}
```

## The ModifyParcelLoadUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyParcelLoadUnit":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyParcelLoadUnit', because you want to modify loadunitRefs in Parcel","enum":["ModifyParcelLoadUnit"],"type":"string"},"loadUnitRefs":{"items":{"type":"string"},"type":"array"}},"required":["action","loadUnitRefs"],"type":"object"}],"description":"Modify Parcels of a LoadUnit.","title":"ModifyParcelLoadUnitsAction","xml":{"name":"ModifyParcelLoadUnit"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The ModifyPartialStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPartialStock":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPartialStock', because you want to modify a partial stock","enum":["ModifyPartialStock"],"type":"string"},"partialStocks":{"items":{"$ref":"#/components/schemas/PartialStockForCreation"},"minItems":0,"type":"array"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyPartialStock"},"title":"ModifyPartialStock","description":"ModifyPartialStock"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"}}}}
```

## The ModifyPickJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPickJob":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPickJob', because you want to modify a pickjob","enum":["ModifyPickJob"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the pickJob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"preferredPickingMethods":{"description":"Preferred way of picking a given pickJob.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"status":{"$ref":"#/components/schemas/PickJobStatusUnprotected"}},"required":["action"],"type":"object"}],"description":"Action to modify a PickJob.","title":"ModifyPickJob","xml":{"name":"ModifyPickJob"}},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickJobStatusUnprotected":{"description":"The status of a pickjob. These are the status that are still allowed to be used in the deprecated status field of ModifyPickJob actions","enum":["OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","PAUSED","WAITING_FOR_INPUT"],"type":"string","xml":{"name":"PickJobStatusUnprotected"},"title":"PickJobStatusUnprotected"}}}}
```

## The ModifyPickJobLastEditor object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPickJobLastEditor":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPickJobLastEditor' to set the last editor to your user and therefor take over the pickjob.","enum":["ModifyPickJobLastEditor"],"type":"string"}},"required":["action"],"type":"object"}],"description":"Action to modify the last editor of a PickJob.","title":"ModifyPickJobLastEditor","xml":{"name":"ModifyPickJobLastEditor"}}}}}
```

## The ModifyPickJobLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPickJobLineItemsActionEnum":{"enum":["MODIFY_PICK_JOB_LINE_ITEMS"],"type":"string","title":"ModifyPickJobLineItemsActionEnum","description":"ModifyPickJobLineItemsActionEnum"}}}}
```

## The ModifyPickLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPickLineItem":{"allOf":[{"additionalProperties":false,"properties":{"shortPickReasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyPickLineItem', because you want to modify a pick line item","enum":["ModifyPickLineItem"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"scannedCodes":{"description":"Scanned Codes of the given picked line item","items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minItems":0},"secondaryPicked":{"type":"integer"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItemForUpsert"},"type":"array"}},"required":["id","action"],"type":"object"}],"description":"Action to modify a picklineitem of a PickJob.","title":"ModifyPickLineItem","xml":{"name":"ModifyPickLineItem"}},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItemForUpsert":{"properties":{"id":{"description":"The id of the substitute line item to update. If none is passed, a new substitute line item will be created.","type":"string"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"tenantArticleId":{"description":"TenantArticleId of the substitute article","type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"SubstituteLineItemForUpsert","description":"SubstituteLineItemForUpsert"}}}}
```

## The ModifyPickLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPickLineItemsActionParameter":{"additionalProperties":false,"description":"Action to modify picklineItems of a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/ModifyPickJobLineItemsActionEnum"},"pickJobLineItemUpdates":{"items":{"$ref":"#/components/schemas/PickLineItemUpdate"},"minItems":1,"type":"array"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","pickJobLineItemUpdates"],"title":"ModifyPickLineItemsActionParameter","type":"object"},"ModifyPickJobLineItemsActionEnum":{"enum":["MODIFY_PICK_JOB_LINE_ITEMS"],"type":"string","title":"ModifyPickJobLineItemsActionEnum","description":"ModifyPickJobLineItemsActionEnum"},"PickLineItemUpdate":{"additionalProperties":false,"properties":{"customAttributes":{"description":"Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"},"maxItems":50,"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"scannedCodes":{"description":"Scanned Codes of the given picked line item","items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"maxItems":50,"minItems":0,"type":"array"},"secondaryPicked":{"type":"integer"},"shortPickReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}}},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItemForUpsert"},"maxItems":50,"type":"array"}},"required":["id"],"type":"object","title":"PickLineItemUpdate","description":"PickLineItemUpdate"},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItemForUpsert":{"properties":{"id":{"description":"The id of the substitute line item to update. If none is passed, a new substitute line item will be created.","type":"string"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"tenantArticleId":{"description":"TenantArticleId of the substitute article","type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"SubstituteLineItemForUpsert","description":"SubstituteLineItemForUpsert"}}}}
```

## The ModifyPickRunLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPickRunLineItem":{"allOf":[{"properties":{"action":{"description":"Use value 'ModifyPickRunLineItem', because you want to modify a pick line item","enum":["ModifyPickRunLineItem"],"type":"string"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/ShortPickReasonForUpsert"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"}},"required":["id","action"],"type":"object"}],"description":"Action to modify a lineitem of a pickrun","title":"ModifyPickRunLineItem","xml":{"name":"ModifyPickRunLineItem"}},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"ShortPickReasonForUpsert":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object","title":"ShortPickReasonForUpsert","description":"ShortPickReasonForUpsert"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"}}}}
```

## The ModifyPrioritizationAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyPrioritizationAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyPrioritization', because you want to modify prioritization.","enum":["ModifyPrioritization"],"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["action","id"],"type":"object"}],"description":"Action to Modify the Prioritization Configuration.","title":"ModifyPrioritizationAction","xml":{"name":"ModifyPrioritizationAction"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The ModifyRatingAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyRatingAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyRating', because you want to modify a rating.","enum":["ModifyRating"],"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"}},"required":["action","id"],"type":"object"}],"description":"Action to Modify a Rating.","title":"ModifyRatingAction","xml":{"name":"ModifyRatingAction"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The ModifyRestowItemAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyRestowItemAction":{"additionalProperties":false,"description":"Action to modify a restow item.","properties":{"action":{"description":"Use value 'ModifyRestowItem', because you want to modify a restow item","enum":["ModifyRestowItem"],"type":"string"},"location":{"$ref":"#/components/schemas/Location"},"restowed":{"default":false,"description":"Indicates if the restowItem has been restowed","type":"boolean"}},"required":["action","restowed"],"title":"ModifyRestowItemAction","type":"object"},"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"}}}}
```

## The ModifyRetainedOfflineStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyRetainedOfflineStock":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Concept depreated. Use safety stock instead.","enum":["ModifyRetainedOfflineStock"],"type":"string"},"active":{"description":"The retained Offline Stock is enabled or disabled.","type":"boolean"},"value":{"default":0.2,"description":"The overall percentage of stock that should be reserved to offline clients.","maximum":1,"minimum":0.01,"type":"number"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Concept depreated. Use safety stock instead.","title":"ModifyRetainedOfflineStockAction","xml":{"name":"ModifyRetainedOfflineStock"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The ModifyRoutingPlanAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyRoutingPlanAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyRoutingPlan', because you want to modify a routing plan","enum":["ModifyRoutingPlan"],"type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyRoutingPlanAction"},"title":"ModifyRoutingPlanAction","description":"ModifyRoutingPlanAction"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"}}}}
```

## The ModifyShipment object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyShipment":{"allOf":[{"additionalProperties":false,"properties":{"action":{"$ref":"#/components/schemas/ModifyShipmentActionEnum"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The reference to the pickjob for which the shipment is assigned to","type":"string"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyShipment"},"title":"ModifyShipment","description":"ModifyShipment"},"ModifyShipmentActionEnum":{"description":"Use value 'ModifyShipment', because you want to modify a shipment","enum":["ModifyShipment"],"type":"string","title":"ModifyShipmentActionEnum"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"},"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"},"maxItems":500,"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"}}}}
```

## The ModifyShipmentActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyShipmentActionEnum":{"description":"Use value 'ModifyShipment', because you want to modify a shipment","enum":["ModifyShipment"],"type":"string","title":"ModifyShipmentActionEnum"}}}}
```

## The ModifyShortpick object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyShortpick":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyShortpick', if you want to modify the ModifyShortPick of a facility","enum":["ModifyShortpick"],"type":"string"},"active":{"default":true,"description":"Inventory adjustment in the case of insufficient order picking","type":"boolean"}},"required":["action"],"type":"object"}],"description":"Modify Shortpick Action.","title":"ModifyShortpick","xml":{"name":"ModifyShortpick"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The ModifyStorageLocationAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyStorageLocationAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyStorageLocation', because you want to modify a storage location","enum":["ModifyStorageLocation"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the storage location. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"deprecated":true,"description":"The traits of this storage location. Do not use this to write traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs.","type":"string"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyStorageLocationAction"},"title":"ModifyStorageLocationAction","description":"ModifyStorageLocationAction"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"}}}}
```

## The ModifyStowLineItemsAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyStowLineItemsAction":{"description":"MODIFY_STOW_LINE_ITEMS targets specific stowJob.stowLineItems by ID. Each targeted entry is partially updated: provided fields are completely replaced, while unspecified fields remain unchanged. New entries can be added by omitting the ID field.","properties":{"name":{"description":"The name of the action that should be performed","enum":["MODIFY_STOW_LINE_ITEMS"],"type":"string"},"stowLineItems":{"items":{"$ref":"#/components/schemas/StowLineItemForUpdate"},"type":"array"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name","stowLineItems"],"title":"ModifyStowLineItemsAction","type":"object"},"StowLineItemForUpdate":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowLineItemArticle"}],"description":"The article that should be stowed"},"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"},"id":{"description":"The ID of the stowLineItem. Leave empty for creation","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonInput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToForUpdate"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFromForCreation"}],"description":"Instructions on how and where to take the item from"}},"title":"StowLineItemForUpdate","type":"object","description":"StowLineItemForUpdate"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonInput":{"properties":{"reasonLocalized":{"description":"List of localized reason strings. If provided, no preconfiguration is necessary. Cannot be provided in combination with id or existing tenantReasonId.","type":"object"},"id":{"description":"ID of reason. Use to enrich with preconfigured reason","type":"string"},"tenantReasonId":{"description":"tenantReasonId of reason. If no reasonLocalized provided, a preconfigured reason with the tenantReasonId must be present","type":"string"}},"title":"ExternalStockChangeReasonInput","type":"object","description":"ExternalStockChangeReasonInput"},"StowLineItemStowToForUpdate":{"properties":{"id":{"type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowToForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowToForUpdate","type":"object","description":"StowLineItemStowToForUpdate"},"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"},"StowLineItemTakeFromForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFromForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFromForCreation","type":"object","description":"StowLineItemTakeFromForCreation"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFromForCreation":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFromForCreation","type":"object","description":"TakenStowLineItemTakeFromForCreation"}}}}
```

## The ModifyTimingModeAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyTimingModeAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyTimingMode', because you want to modify a timing mode.","enum":["ModifyTimingMode"],"type":"string"},"timingMode":{"$ref":"#/components/schemas/RoutingConfigurationTiming"}},"required":["action"],"type":"object"}],"description":"Action to Modify the Timing Mode.","title":"ModifyTimingModeAction","xml":{"name":"ModifyTimingModeAction"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"RoutingConfigurationTiming":{"description":"Configuration for the timing of routing decisions","properties":{"options":{"type":"object"},"type":{"$ref":"#/components/schemas/RoutingConfigurationTimingType"}},"required":["type"],"type":"object","title":"RoutingConfigurationTiming"},"RoutingConfigurationTimingType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The available types for routing timing.","enum":["DIRECT","MANUAL"],"type":"string","xml":{"name":"RoutingConfigurationTimingType"},"title":"RoutingConfigurationTimingType"}}}}
```

## The ModifyUserAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyUserAction":{"properties":{"action":{"allOf":[{"$ref":"#/components/schemas/UserActionEnum"}],"description":"The type of action to perform"},"assignedFacilities":{"deprecated":true,"description":"Deprecated: Use assignedRoles with contextLimitation of type FACILITY instead","items":{"$ref":"#/components/schemas/UserAssignedFacilityForCreation"},"type":"array"},"assignedRoles":{"description":"The new roles of the user","items":{"$ref":"#/components/schemas/AssignedRoles"},"maxItems":100,"type":"array"},"customAttributes":{"description":"The new custom attributes of the user","nullable":true,"type":"object"},"email":{"description":"The changed email of the user","type":"string"},"firstname":{"description":"The new firstname of the user","type":"string"},"lastname":{"description":"The new lastname of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"password":{"description":"The new password of the user","type":"string"},"roles":{"deprecated":true,"description":"Deprecated: Use assignedRoles instead","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["action"],"title":"ModifyUserAction","type":"object","description":"ModifyUserAction"},"UserActionEnum":{"description":"The type of action to perform","enum":["ModifyUser"],"title":"UserActionEnum","type":"string"},"UserAssignedFacilityForCreation":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef"],"title":"UserAssignedFacilityForCreation","type":"object","description":"UserAssignedFacilityForCreation"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The ModifyUserPersonalData object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModifyUserPersonalData":{"properties":{"firstname":{"description":"The new firstname of the user","type":"string"},"lastname":{"description":"The new lastname of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"}},"title":"ModifyUserPersonalData","type":"object","description":"ModifyUserPersonalData"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"}}}}
```

## The ModuleEntity object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"}}}}
```

## The ModuleEntityStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"}}}}
```

## The ModuleEntityStatusHistoryItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"}}}}
```

## The ModuleStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"}}}}
```

## The ModuleStatusItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"}}}}
```

## The ModuleType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"}}}}
```

## The MonetaryValue object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"}}}}
```

## The Money object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The MoveHandoverJobLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MoveHandoverJobLineItemsActionEnum":{"enum":["MOVE_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"MoveHandoverJobLineItemsActionEnum","description":"MoveHandoverJobLineItemsActionEnum"}}}}
```

## The MoveHandoverJobLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MoveHandoverJobLineItemsActionParameter":{"additionalProperties":false,"description":"Action to move line items of a handover job from line items array to another (expected, missing, handover)","properties":{"items":{"items":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsInfo"},"maxItems":50,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","items"],"title":"MoveHandoverJobLineItemsActionParameter"},"MoveHandoverJobLineItemsInfo":{"additionalProperties":false,"description":"Information about the line items that should be moved from one array to another","properties":{"from":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsArrayTypeEnum"},"lineItemId":{"description":"References the id of the line item of a handover job. Can be the id of a expectedHandoverJobLineItem, handoverLineItem or missingHandoverJobLineItem","type":"string"},"targetQuantity":{"description":"The quantity of the line item that should be moved.","minimum":1,"type":"integer"},"to":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsArrayTypeEnum"}},"required":["lineItemId","from","to","targetQuantity"],"title":"MoveHandoverJobLineItemsInfo"},"MoveHandoverJobLineItemsArrayTypeEnum":{"enum":["EXPECTED","HANDOVER","MISSING"],"type":"string","title":"MoveHandoverJobLineItemsArrayTypeEnum","description":"MoveHandoverJobLineItemsArrayTypeEnum"},"MoveHandoverJobLineItemsActionEnum":{"enum":["MOVE_HANDOVER_JOB_LINE_ITEMS"],"type":"string","title":"MoveHandoverJobLineItemsActionEnum","description":"MoveHandoverJobLineItemsActionEnum"}}}}
```

## The MoveHandoverJobLineItemsArrayTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MoveHandoverJobLineItemsArrayTypeEnum":{"enum":["EXPECTED","HANDOVER","MISSING"],"type":"string","title":"MoveHandoverJobLineItemsArrayTypeEnum","description":"MoveHandoverJobLineItemsArrayTypeEnum"}}}}
```

## The MoveHandoverJobLineItemsInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MoveHandoverJobLineItemsInfo":{"additionalProperties":false,"description":"Information about the line items that should be moved from one array to another","properties":{"from":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsArrayTypeEnum"},"lineItemId":{"description":"References the id of the line item of a handover job. Can be the id of a expectedHandoverJobLineItem, handoverLineItem or missingHandoverJobLineItem","type":"string"},"targetQuantity":{"description":"The quantity of the line item that should be moved.","minimum":1,"type":"integer"},"to":{"$ref":"#/components/schemas/MoveHandoverJobLineItemsArrayTypeEnum"}},"required":["lineItemId","from","to","targetQuantity"],"title":"MoveHandoverJobLineItemsInfo"},"MoveHandoverJobLineItemsArrayTypeEnum":{"enum":["EXPECTED","HANDOVER","MISSING"],"type":"string","title":"MoveHandoverJobLineItemsArrayTypeEnum","description":"MoveHandoverJobLineItemsArrayTypeEnum"}}}}
```

## The MoveStockToLocationOptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MoveStockToLocationOptions":{"properties":{"deleteFromStockIfZero":{"type":"boolean"}},"title":"MoveStockToLocationOptions","type":"object","description":"MoveStockToLocationOptions"}}}}
```

## The MultiOrderPickingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MultiOrderPickingConfiguration":{"additionalProperties":false,"properties":{"maxAmountOfPickJobsForMultiOrderPick":{"description":"The maximum amount of pick jobs that can be combined in a multi order pick. Must be a value between 1 and 100.","maximum":100,"minimum":1,"type":"integer"}},"required":["maxAmountOfPickJobsForMultiOrderPick"],"type":"object","title":"MultiOrderPickingConfiguration","description":"MultiOrderPickingConfiguration"}}}}
```

## The NamedFile object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"}}}}
```

## The NeedsPacking object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NeedsPacking":{"properties":{"needsPacking":{"type":"boolean"}},"required":["needsPacking"],"type":"object","title":"NeedsPacking","description":"NeedsPacking"}}}}
```

## The NodeType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"}}}}
```

## The NonDeliveryDays object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"}}}}
```

## The NonDeliveryDaysPerCountryAndProvince object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"}}}}
```

## The NonDeliveryDaysPerProvince object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"}}}}
```

## The NonDeliveryType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NonDeliveryType":{"enum":["SINGLE","RECURRING"],"type":"string","title":"NonDeliveryType","description":"NonDeliveryType"}}}}
```

## The Notification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Notification":{"properties":{"category":{"description":"The category of the notification.","enum":["ORDER","FACILITY","MISC"],"type":"string"},"created":{"description":"Timestamp when the notification was created.","format":"date-time","type":"string"},"event":{"description":"The event name that triggered the notification.","type":"string"},"id":{"description":"Identifier of the notification.","type":"string"},"lastModified":{"description":"Last modification timestamp of the notification.","format":"date-time","type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/NotificationPayload"}],"description":"The payload of the notification."},"priority":{"allOf":[{"$ref":"#/components/schemas/NotificationPriority"}],"description":"The priority of the notification"},"status":{"description":"The status of the notification","enum":["OPEN","FINISHED"],"type":"string"},"type":{"description":"The type of the notification channel.","enum":["EMAIL","CLIENT"],"type":"string"},"version":{"description":"Current version of the notification.","type":"number"}},"required":["created","id","lastModified","version","category","status","priority","event","payload","type"],"title":"Notification","type":"object","description":"Notification"},"NotificationPayload":{"properties":{"titleLocalized":{"additionalProperties":{"type":"string"},"description":"The localized title of the notification (only for client notifications).","type":"object"},"subjectLocalized":{"additionalProperties":{"type":"string"},"description":"The localized subject of the notification (only for email notifications).","type":"object"},"messageLocalized":{"additionalProperties":{"type":"string"},"description":"The localized message of the notification.","type":"object"},"entityLinks":{"description":"Array of entity links related to this notification","items":{"$ref":"#/components/schemas/EntityLink"},"type":"array"},"message":{"description":"The message of the notification.","type":"string"},"subject":{"description":"The subject of the notification (only for email notifications).","type":"string"},"title":{"description":"The title of the notification (only for client notifications).","type":"string"}},"required":["messageLocalized","entityLinks"],"title":"NotificationPayload","type":"object","description":"NotificationPayload"},"EntityLink":{"properties":{"ref":{"description":"The reference ID of the linked entity","type":"string"},"type":{"description":"The type of the linked entity","enum":["ORDER","FACILITY","ROUTING_PLAN","PROCESS","PICK_JOB"],"type":"string"}},"required":["ref","type"],"title":"EntityLink","type":"object","description":"EntityLink"},"NotificationPriority":{"properties":{"label":{"description":"Priority label","enum":["LOW","MEDIUM","HIGH"],"type":"string"},"sequence":{"description":"Priority sequence number","type":"number"}},"required":["sequence","label"],"title":"NotificationPriority","type":"object","description":"NotificationPriority"}}}}
```

## The NotificationAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationAction":{"properties":{"name":{"description":"Which action to perform","enum":["ACK_NOTIFICATION"],"type":"string"},"version":{"description":"The current version of the notification that should be modified","type":"number"}},"required":["version","name"],"title":"NotificationAction","type":"object","description":"NotificationAction"}}}}
```

## The NotificationApiNotificationStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationApiNotificationStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","FINISHED"],"type":"string"}},"title":"NotificationApiNotificationStatusEnumFilter","type":"object","description":"NotificationApiNotificationStatusEnumFilter"}}}}
```

## The NotificationCategoryEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationCategoryEnumFilter":{"properties":{"eq":{"description":"Search by category","enum":["ORDER","FACILITY","MISC"],"type":"string"},"in":{"description":"Search by category","items":{"enum":["ORDER","FACILITY","MISC"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by category","enum":["ORDER","FACILITY","MISC"],"type":"string"}},"title":"NotificationCategoryEnumFilter","type":"object","description":"NotificationCategoryEnumFilter"}}}}
```

## The NotificationCenterConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationCenterConfig":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"maxItems":100,"type":"array"},"created":{"format":"date-time","type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["version","created","lastModified","channels"],"title":"NotificationCenterConfig","type":"object","description":"NotificationCenterConfig"},"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"}}}}
```

## The NotificationCenterConfigForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationCenterConfigForCreation":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"maxItems":100,"type":"array"}},"required":["channels"],"title":"NotificationCenterConfigForCreation","type":"object","description":"NotificationCenterConfigForCreation"},"EmailNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","receiver"],"title":"EmailNotificationChannelForCreation","type":"object","description":"EmailNotificationChannelForCreation"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type"],"title":"ClientNotificationChannelForCreation","type":"object","description":"ClientNotificationChannelForCreation"}}}}
```

## The NotificationCenterConfigForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationCenterConfigForUpdate":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"maxItems":100,"type":"array"},"version":{"type":"number"}},"required":["channels","version"],"title":"NotificationCenterConfigForUpdate","type":"object","description":"NotificationCenterConfigForUpdate"},"EmailNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","receiver"],"title":"EmailNotificationChannelForCreation","type":"object","description":"EmailNotificationChannelForCreation"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type"],"title":"ClientNotificationChannelForCreation","type":"object","description":"ClientNotificationChannelForCreation"}}}}
```

## The NotificationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationPaginatedResult":{"properties":{"notifications":{"items":{"$ref":"#/components/schemas/Notification"},"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","notifications"],"title":"NotificationPaginatedResult","type":"object","description":"NotificationPaginatedResult"},"Notification":{"properties":{"category":{"description":"The category of the notification.","enum":["ORDER","FACILITY","MISC"],"type":"string"},"created":{"description":"Timestamp when the notification was created.","format":"date-time","type":"string"},"event":{"description":"The event name that triggered the notification.","type":"string"},"id":{"description":"Identifier of the notification.","type":"string"},"lastModified":{"description":"Last modification timestamp of the notification.","format":"date-time","type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/NotificationPayload"}],"description":"The payload of the notification."},"priority":{"allOf":[{"$ref":"#/components/schemas/NotificationPriority"}],"description":"The priority of the notification"},"status":{"description":"The status of the notification","enum":["OPEN","FINISHED"],"type":"string"},"type":{"description":"The type of the notification channel.","enum":["EMAIL","CLIENT"],"type":"string"},"version":{"description":"Current version of the notification.","type":"number"}},"required":["created","id","lastModified","version","category","status","priority","event","payload","type"],"title":"Notification","type":"object","description":"Notification"},"NotificationPayload":{"properties":{"titleLocalized":{"additionalProperties":{"type":"string"},"description":"The localized title of the notification (only for client notifications).","type":"object"},"subjectLocalized":{"additionalProperties":{"type":"string"},"description":"The localized subject of the notification (only for email notifications).","type":"object"},"messageLocalized":{"additionalProperties":{"type":"string"},"description":"The localized message of the notification.","type":"object"},"entityLinks":{"description":"Array of entity links related to this notification","items":{"$ref":"#/components/schemas/EntityLink"},"type":"array"},"message":{"description":"The message of the notification.","type":"string"},"subject":{"description":"The subject of the notification (only for email notifications).","type":"string"},"title":{"description":"The title of the notification (only for client notifications).","type":"string"}},"required":["messageLocalized","entityLinks"],"title":"NotificationPayload","type":"object","description":"NotificationPayload"},"EntityLink":{"properties":{"ref":{"description":"The reference ID of the linked entity","type":"string"},"type":{"description":"The type of the linked entity","enum":["ORDER","FACILITY","ROUTING_PLAN","PROCESS","PICK_JOB"],"type":"string"}},"required":["ref","type"],"title":"EntityLink","type":"object","description":"EntityLink"},"NotificationPriority":{"properties":{"label":{"description":"Priority label","enum":["LOW","MEDIUM","HIGH"],"type":"string"},"sequence":{"description":"Priority sequence number","type":"number"}},"required":["sequence","label"],"title":"NotificationPriority","type":"object","description":"NotificationPriority"},"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"}}}}
```

## The NotificationPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationPayload":{"properties":{"titleLocalized":{"additionalProperties":{"type":"string"},"description":"The localized title of the notification (only for client notifications).","type":"object"},"subjectLocalized":{"additionalProperties":{"type":"string"},"description":"The localized subject of the notification (only for email notifications).","type":"object"},"messageLocalized":{"additionalProperties":{"type":"string"},"description":"The localized message of the notification.","type":"object"},"entityLinks":{"description":"Array of entity links related to this notification","items":{"$ref":"#/components/schemas/EntityLink"},"type":"array"},"message":{"description":"The message of the notification.","type":"string"},"subject":{"description":"The subject of the notification (only for email notifications).","type":"string"},"title":{"description":"The title of the notification (only for client notifications).","type":"string"}},"required":["messageLocalized","entityLinks"],"title":"NotificationPayload","type":"object","description":"NotificationPayload"},"EntityLink":{"properties":{"ref":{"description":"The reference ID of the linked entity","type":"string"},"type":{"description":"The type of the linked entity","enum":["ORDER","FACILITY","ROUTING_PLAN","PROCESS","PICK_JOB"],"type":"string"}},"required":["ref","type"],"title":"EntityLink","type":"object","description":"EntityLink"}}}}
```

## The NotificationPriority object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationPriority":{"properties":{"label":{"description":"Priority label","enum":["LOW","MEDIUM","HIGH"],"type":"string"},"sequence":{"description":"Priority sequence number","type":"number"}},"required":["sequence","label"],"title":"NotificationPriority","type":"object","description":"NotificationPriority"}}}}
```

## The NotificationPriorityFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationPriorityFilter":{"properties":{"label":{"allOf":[{"$ref":"#/components/schemas/NotificationPriorityPriorityLabelEnumFilter"}],"description":"Search by label"},"sequence":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by sequence"}},"title":"NotificationPriorityFilter","type":"object","description":"NotificationPriorityFilter"},"NotificationPriorityPriorityLabelEnumFilter":{"properties":{"eq":{"description":"Search by label","enum":["LOW","MEDIUM","HIGH"],"type":"string"},"in":{"description":"Search by label","items":{"enum":["LOW","MEDIUM","HIGH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by label","enum":["LOW","MEDIUM","HIGH"],"type":"string"}},"title":"NotificationPriorityPriorityLabelEnumFilter","type":"object","description":"NotificationPriorityPriorityLabelEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"}}}}
```

## The NotificationPriorityPriorityLabelEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationPriorityPriorityLabelEnumFilter":{"properties":{"eq":{"description":"Search by label","enum":["LOW","MEDIUM","HIGH"],"type":"string"},"in":{"description":"Search by label","items":{"enum":["LOW","MEDIUM","HIGH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by label","enum":["LOW","MEDIUM","HIGH"],"type":"string"}},"title":"NotificationPriorityPriorityLabelEnumFilter","type":"object","description":"NotificationPriorityPriorityLabelEnumFilter"}}}}
```

## The NotificationSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationSearchPayload":{"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/NotificationSearchQuery"},"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/NotificationSort"},"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":"NotificationSearchPayload","type":"object","description":"NotificationSearchPayload"},"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"},"NotificationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/NotificationSearchQuery"},"maxItems":500,"type":"array"},"category":{"allOf":[{"$ref":"#/components/schemas/NotificationCategoryEnumFilter"}],"description":"Search by category"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"or":{"items":{"$ref":"#/components/schemas/NotificationSearchQuery"},"maxItems":500,"type":"array"},"priority":{"allOf":[{"$ref":"#/components/schemas/NotificationPriorityFilter"}],"description":"Nested search by priority"},"status":{"allOf":[{"$ref":"#/components/schemas/NotificationApiNotificationStatusEnumFilter"}],"description":"Search by status"}},"title":"NotificationSearchQuery","type":"object","description":"NotificationSearchQuery"},"NotificationCategoryEnumFilter":{"properties":{"eq":{"description":"Search by category","enum":["ORDER","FACILITY","MISC"],"type":"string"},"in":{"description":"Search by category","items":{"enum":["ORDER","FACILITY","MISC"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by category","enum":["ORDER","FACILITY","MISC"],"type":"string"}},"title":"NotificationCategoryEnumFilter","type":"object","description":"NotificationCategoryEnumFilter"},"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"},"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"},"NotificationPriorityFilter":{"properties":{"label":{"allOf":[{"$ref":"#/components/schemas/NotificationPriorityPriorityLabelEnumFilter"}],"description":"Search by label"},"sequence":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by sequence"}},"title":"NotificationPriorityFilter","type":"object","description":"NotificationPriorityFilter"},"NotificationPriorityPriorityLabelEnumFilter":{"properties":{"eq":{"description":"Search by label","enum":["LOW","MEDIUM","HIGH"],"type":"string"},"in":{"description":"Search by label","items":{"enum":["LOW","MEDIUM","HIGH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by label","enum":["LOW","MEDIUM","HIGH"],"type":"string"}},"title":"NotificationPriorityPriorityLabelEnumFilter","type":"object","description":"NotificationPriorityPriorityLabelEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"NotificationApiNotificationStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","FINISHED"],"type":"string"}},"title":"NotificationApiNotificationStatusEnumFilter","type":"object","description":"NotificationApiNotificationStatusEnumFilter"},"NotificationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"NotificationSort","type":"object","description":"NotificationSort"}}}}
```

## The NotificationSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/NotificationSearchQuery"},"maxItems":500,"type":"array"},"category":{"allOf":[{"$ref":"#/components/schemas/NotificationCategoryEnumFilter"}],"description":"Search by category"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"or":{"items":{"$ref":"#/components/schemas/NotificationSearchQuery"},"maxItems":500,"type":"array"},"priority":{"allOf":[{"$ref":"#/components/schemas/NotificationPriorityFilter"}],"description":"Nested search by priority"},"status":{"allOf":[{"$ref":"#/components/schemas/NotificationApiNotificationStatusEnumFilter"}],"description":"Search by status"}},"title":"NotificationSearchQuery","type":"object","description":"NotificationSearchQuery"},"NotificationCategoryEnumFilter":{"properties":{"eq":{"description":"Search by category","enum":["ORDER","FACILITY","MISC"],"type":"string"},"in":{"description":"Search by category","items":{"enum":["ORDER","FACILITY","MISC"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by category","enum":["ORDER","FACILITY","MISC"],"type":"string"}},"title":"NotificationCategoryEnumFilter","type":"object","description":"NotificationCategoryEnumFilter"},"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"},"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"},"NotificationPriorityFilter":{"properties":{"label":{"allOf":[{"$ref":"#/components/schemas/NotificationPriorityPriorityLabelEnumFilter"}],"description":"Search by label"},"sequence":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by sequence"}},"title":"NotificationPriorityFilter","type":"object","description":"NotificationPriorityFilter"},"NotificationPriorityPriorityLabelEnumFilter":{"properties":{"eq":{"description":"Search by label","enum":["LOW","MEDIUM","HIGH"],"type":"string"},"in":{"description":"Search by label","items":{"enum":["LOW","MEDIUM","HIGH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by label","enum":["LOW","MEDIUM","HIGH"],"type":"string"}},"title":"NotificationPriorityPriorityLabelEnumFilter","type":"object","description":"NotificationPriorityPriorityLabelEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"NotificationApiNotificationStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","FINISHED"],"type":"string"}},"title":"NotificationApiNotificationStatusEnumFilter","type":"object","description":"NotificationApiNotificationStatusEnumFilter"}}}}
```

## The NotificationSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NotificationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"NotificationSort","type":"object","description":"NotificationSort"}}}}
```

## The NumberEqFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"}}}}
```

## The NumberFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"}}}}
```

## The OfferedDocument object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"}}}}
```

## The OfferedDocumentPerTag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"}}}}
```

## The OfferedScanningRuleByTag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OfferedScanningRuleByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"scanningType":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"tagRef":{"minLength":1,"type":"string"}},"required":["tagRef","matchingValues","scanningType"],"type":"object","title":"OfferedScanningRuleByTag","description":"OfferedScanningRuleByTag"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"}}}}
```

## The OfferedStickersByTag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OidcProviderCustomParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OidcProviderCustomParameter":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"title":"OidcProviderCustomParameter","type":"object","description":"OidcProviderCustomParameter"}}}}
```

## The OidcProviderForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OidcProviderForCreation":{"properties":{"assignedGroups":{"description":"The assigned groups of the OIDC provider","items":{"$ref":"#/components/schemas/AssignedGroup"},"type":"array"},"clientId":{"description":"The client id of the OIDC provider","type":"string"},"clientSecret":{"description":"The client secret of the OIDC provider","type":"string"},"customParameters":{"description":"The custom parameters of the OIDC provider","items":{"$ref":"#/components/schemas/OidcProviderCustomParameter"},"type":"array"},"issuer":{"description":"The issuer of the OIDC provider","type":"string"},"name":{"description":"The name of the OIDC provider","type":"string"},"roleManagementMode":{"description":"Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.","enum":["IDP_MANAGED","IDP_IDENTITY_ONLY"],"type":"string"},"status":{"description":"The status of the OIDC provider","enum":["ACTIVE","INACTIVE"],"type":"string"}},"required":["name","status","issuer","clientId","customParameters","assignedGroups","clientSecret"],"title":"OidcProviderForCreation","type":"object","description":"OidcProviderForCreation"},"AssignedGroup":{"properties":{"facilityRefs":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"}},"required":["facilityRefs","group"],"title":"AssignedGroup","type":"object","description":"AssignedGroup"},"OidcProviderCustomParameter":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"title":"OidcProviderCustomParameter","type":"object","description":"OidcProviderCustomParameter"}}}}
```

## The OidcProviderForPatch object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OidcProviderForPatch":{"properties":{"assignedGroups":{"description":"The assigned groups of the OIDC provider","items":{"$ref":"#/components/schemas/AssignedGroup"},"type":"array"},"clientId":{"description":"The client id of the OIDC provider","type":"string"},"clientSecret":{"description":"The client secret of the OIDC provider","type":"string"},"customParameters":{"description":"The custom parameters of the OIDC provider","items":{"$ref":"#/components/schemas/OidcProviderCustomParameter"},"type":"array"},"issuer":{"description":"The issuer of the OIDC provider","type":"string"},"name":{"description":"The name of the OIDC provider","type":"string"},"roleManagementMode":{"description":"Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.","enum":["IDP_MANAGED","IDP_IDENTITY_ONLY"],"type":"string"},"status":{"description":"The status of the OIDC provider","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the OIDC provider","type":"number"}},"required":["version"],"title":"OidcProviderForPatch","type":"object","description":"OidcProviderForPatch"},"AssignedGroup":{"properties":{"facilityRefs":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"}},"required":["facilityRefs","group"],"title":"AssignedGroup","type":"object","description":"AssignedGroup"},"OidcProviderCustomParameter":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"title":"OidcProviderCustomParameter","type":"object","description":"OidcProviderCustomParameter"}}}}
```

## The OidcProviderForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OidcProviderForUpdate":{"properties":{"assignedGroups":{"description":"The assigned groups of the OIDC provider","items":{"$ref":"#/components/schemas/AssignedGroup"},"type":"array"},"clientId":{"description":"The client id of the OIDC provider","type":"string"},"clientSecret":{"description":"The client secret of the OIDC provider","type":"string"},"customParameters":{"description":"The custom parameters of the OIDC provider","items":{"$ref":"#/components/schemas/OidcProviderCustomParameter"},"type":"array"},"issuer":{"description":"The issuer of the OIDC provider","type":"string"},"name":{"description":"The name of the OIDC provider","type":"string"},"roleManagementMode":{"description":"Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.","enum":["IDP_MANAGED","IDP_IDENTITY_ONLY"],"type":"string"},"status":{"description":"The status of the OIDC provider","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the OIDC provider","type":"number"}},"required":["name","status","issuer","clientId","customParameters","assignedGroups","clientSecret","version"],"title":"OidcProviderForUpdate","type":"object","description":"OidcProviderForUpdate"},"AssignedGroup":{"properties":{"facilityRefs":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"}},"required":["facilityRefs","group"],"title":"AssignedGroup","type":"object","description":"AssignedGroup"},"OidcProviderCustomParameter":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"title":"OidcProviderCustomParameter","type":"object","description":"OidcProviderCustomParameter"}}}}
```

## The OidcProviders object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OidcProviders":{"properties":{"providers":{"description":"The list of OIDC providers","items":{"$ref":"#/components/schemas/StrippedOidcProvider"},"type":"array"},"total":{"description":"The total number of OIDC providers","type":"number"}},"required":["total","providers"],"title":"OidcProviders","type":"object","description":"OidcProviders"},"StrippedOidcProvider":{"properties":{"assignedGroups":{"description":"The assigned groups of the OIDC provider","items":{"$ref":"#/components/schemas/AssignedGroup"},"type":"array"},"clientId":{"description":"The client id of the OIDC provider","type":"string"},"customParameters":{"description":"The custom parameters of the OIDC provider","items":{"$ref":"#/components/schemas/OidcProviderCustomParameter"},"type":"array"},"id":{"description":"The id of the OIDC provider","type":"string"},"issuer":{"description":"The issuer of the OIDC provider","type":"string"},"name":{"description":"The name of the OIDC provider","type":"string"},"roleManagementMode":{"description":"Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.","enum":["IDP_MANAGED","IDP_IDENTITY_ONLY"],"type":"string"},"status":{"description":"The status of the OIDC provider","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the OIDC provider","type":"number"}},"required":["name","status","issuer","clientId","customParameters","assignedGroups","id","version"],"title":"StrippedOidcProvider","type":"object","description":"StrippedOidcProvider"},"AssignedGroup":{"properties":{"facilityRefs":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"}},"required":["facilityRefs","group"],"title":"AssignedGroup","type":"object","description":"AssignedGroup"},"OidcProviderCustomParameter":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"title":"OidcProviderCustomParameter","type":"object","description":"OidcProviderCustomParameter"}}}}
```

## The OpenItemReturnActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OpenItemReturnActionParameter":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"enum":["OpenItemReturn"],"type":"string"}},"required":["name","itemReturnJobVersion"],"title":"OpenItemReturnActionParameter","type":"object","description":"OpenItemReturnActionParameter"}}}}
```

## The OperationalRestowingConfigurations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperationalRestowingConfigurations":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"restowingProcessConfiguration":{"$ref":"#/components/schemas/RestowingProcessConfiguration"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"OperationalRestowingConfigurations","description":"OperationalRestowingConfigurations"},"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"},"RestowingProcessConfiguration":{"properties":{"restowingProcessTypes":{"items":{"$ref":"#/components/schemas/RestowingProcessTypeEnum"},"minItems":0,"type":"array"}},"required":["restowingProcessTypes"],"type":"object","title":"RestowingProcessConfiguration","description":"RestowingProcessConfiguration"},"RestowingProcessTypeEnum":{"description":"Where restow items should be created during the operational process","enum":["PICKING","PACKING","HANDOVER"],"type":"string","title":"RestowingProcessTypeEnum"}}}}
```

## The OperativeContainerType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeContainerType":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"allowedOperativeTypes":{"items":{"enum":["PICKING","PACKING_SOURCE","PACKING_TARGET","HANDOVER","SERVICE"],"type":"string"},"minItems":1,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the operativeContainerType. These attributes cannot be used within fulfillment processes.","type":"object"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"type":"string"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"deprecated":true,"description":"Deprecated: use nameLocalized instead","type":"string"},"priority":{"description":"This value gives the priority of the respective operativeContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"scannableIdentifiers":{"items":{"$ref":"#/components/schemas/ScannableIdentifier"},"maxItems":1,"type":"array"},"status":{"enum":["INACTIVE","ACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with.","minimum":1,"type":"number"}},"required":["version","id","nameLocalized","allowedOperativeTypes"],"title":"OperativeContainerType","type":"object","description":"OperativeContainerType"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ScannableIdentifier":{"properties":{"identifiers":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"searchType":{"enum":["PREFIX","SUFFIX","CONTAINS"],"type":"string"}},"required":["identifiers"],"title":"ScannableIdentifier","type":"object","description":"ScannableIdentifier"}}}}
```

## The OperativeContainerTypeForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeContainerTypeForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"allowedOperativeTypes":{"items":{"enum":["PICKING","PACKING_SOURCE","PACKING_TARGET","HANDOVER","SERVICE"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the operativeContainerType. These attributes cannot be used within fulfillment processes.","type":"object"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"icon":{"$ref":"#/components/schemas/NamedFile"},"iconUrl":{"type":"string"},"priority":{"description":"This value gives the priority of the respective operativeContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"scannableIdentifiers":{"items":{"$ref":"#/components/schemas/ScannableIdentifier"},"maxItems":1,"type":"array"},"status":{"enum":["INACTIVE","ACTIVE"],"type":"string"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with.","minimum":1,"type":"number"}},"required":["nameLocalized","allowedOperativeTypes"],"title":"OperativeContainerTypeForCreation","type":"object","description":"OperativeContainerTypeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"ScannableIdentifier":{"properties":{"identifiers":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"searchType":{"enum":["PREFIX","SUFFIX","CONTAINS"],"type":"string"}},"required":["identifiers"],"title":"ScannableIdentifier","type":"object","description":"ScannableIdentifier"}}}}
```

## The OperativeContainerTypeForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeContainerTypeForUpdate":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"allowedOperativeTypes":{"items":{"enum":["PICKING","PACKING_SOURCE","PACKING_TARGET","HANDOVER","SERVICE"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the operativeContainerTypes. These attributes cannot be used within fulfillment processes.","type":"object"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"type":"string"},"priority":{"description":"This value gives the priority of the respective operativeContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"scannableIdentifiers":{"items":{"$ref":"#/components/schemas/ScannableIdentifier"},"maxItems":1,"type":"array"},"status":{"enum":["INACTIVE","ACTIVE"],"type":"string"},"version":{"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with.","minimum":1,"type":"number"}},"required":["version"],"title":"OperativeContainerTypeForUpdate","type":"object","description":"OperativeContainerTypeForUpdate"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ScannableIdentifier":{"properties":{"identifiers":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"searchType":{"enum":["PREFIX","SUFFIX","CONTAINS"],"type":"string"}},"required":["identifiers"],"title":"ScannableIdentifier","type":"object","description":"ScannableIdentifier"}}}}
```

## The OperativeContainerTypesResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeContainerTypesResponse":{"properties":{"operativeContainerTypes":{"items":{"$ref":"#/components/schemas/OperativeContainerType"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"OperativeContainerTypesResponse","type":"object","description":"OperativeContainerTypesResponse"},"OperativeContainerType":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"allowedOperativeTypes":{"items":{"enum":["PICKING","PACKING_SOURCE","PACKING_TARGET","HANDOVER","SERVICE"],"type":"string"},"minItems":1,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the operativeContainerType. These attributes cannot be used within fulfillment processes.","type":"object"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"type":"string"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"deprecated":true,"description":"Deprecated: use nameLocalized instead","type":"string"},"priority":{"description":"This value gives the priority of the respective operativeContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"scannableIdentifiers":{"items":{"$ref":"#/components/schemas/ScannableIdentifier"},"maxItems":1,"type":"array"},"status":{"enum":["INACTIVE","ACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with.","minimum":1,"type":"number"}},"required":["version","id","nameLocalized","allowedOperativeTypes"],"title":"OperativeContainerType","type":"object","description":"OperativeContainerType"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ScannableIdentifier":{"properties":{"identifiers":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"searchType":{"enum":["PREFIX","SUFFIX","CONTAINS"],"type":"string"}},"required":["identifiers"],"title":"ScannableIdentifier","type":"object","description":"ScannableIdentifier"}}}}
```

## The OperativeEntity object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeEntity":{"properties":{"entityChildren":{"description":"Tree structure of entities belonging to this entity","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"entityRef":{"description":"Reference to the full entity","type":"string"},"entityType":{"description":"Type of the entity","enum":["PICK_JOB","PACK_JOB","SHIPMENT","SHIPPING_INFORMATION","HANDOVER_JOB","PARCEL","PARCEL_INFORMATION","SERVICE_JOB","RESTOW_ITEM","ITEM_RETURN_JOB","LINKED_SERVICE_JOBS","PACKING_TARGET_CONTAINER","LOAD_UNIT","SERVICE_CONTAINER","HANDOVER_CONTAINER"],"type":"string"}},"required":["entityRef","entityType"],"title":"OperativeEntity","type":"object","description":"OperativeEntity"}}}}
```

## The OperativeEntityPayloadBase object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OperativeEntityPickingDoneIncompletePayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeEntityPickingDoneIncompletePayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"shortPickedItems":{"items":{"$ref":"#/components/schemas/OperativeEntityShortPickedItem"},"type":"array"}},"title":"OperativeEntityPickingDoneIncompletePayload","description":"OperativeEntityPickingDoneIncompletePayload"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"}}}}
```

## The OperativeEntityShortPickedItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"}}}}
```

## The OperativeProcess object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeProcess":{"properties":{"created":{"description":"The timestamp when the operative process was created.","format":"date-time","type":"string"},"entityChildren":{"description":"Entities involved in this operative process represented as a hierarchical tree structure.","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"facilityRef":{"description":"Reference to the facility this operative process is associated with.","type":"string"},"flatEntityRefs":{"description":"Entities involved in this operative process represented as a flat list of entity references.","items":{"minLength":0,"type":"string"},"type":"array"},"id":{"description":"auto generated unique identifier","type":"string"},"isEditable":{"description":"This field indicates if the operative process is editable based on if any of the related pick jobs, service jobs, pack jobs or handover jobs are in progress or have been finished successfully. This field is calculated dynamically on each request.","type":"boolean"},"lastModified":{"description":"The timestamp when the operative process was last modified.","format":"date-time","type":"string"},"processRef":{"description":"Reference to the process this operative process is associated with.","type":"string"},"routingPlanRef":{"description":"Reference to the routing plan this operative process is associated with.","type":"string"},"version":{"description":"The version number of the operative process. This number is incremented each time the operative process is modified.","type":"number"}},"required":["id","version","processRef","facilityRef","flatEntityRefs","entityChildren"],"title":"OperativeProcess","type":"object","description":"OperativeProcess"},"OperativeEntity":{"properties":{"entityChildren":{"description":"Tree structure of entities belonging to this entity","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"entityRef":{"description":"Reference to the full entity","type":"string"},"entityType":{"description":"Type of the entity","enum":["PICK_JOB","PACK_JOB","SHIPMENT","SHIPPING_INFORMATION","HANDOVER_JOB","PARCEL","PARCEL_INFORMATION","SERVICE_JOB","RESTOW_ITEM","ITEM_RETURN_JOB","LINKED_SERVICE_JOBS","PACKING_TARGET_CONTAINER","LOAD_UNIT","SERVICE_CONTAINER","HANDOVER_CONTAINER"],"type":"string"}},"required":["entityRef","entityType"],"title":"OperativeEntity","type":"object","description":"OperativeEntity"}}}}
```

## The OperativeProcessPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeProcessPaginatedResult":{"properties":{"operativeProcesses":{"items":{"$ref":"#/components/schemas/OperativeProcess"},"type":"array"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"total":{"minimum":0,"type":"number"}},"required":["total","pageInfo","operativeProcesses"],"title":"OperativeProcessPaginatedResult","type":"object","description":"OperativeProcessPaginatedResult"},"OperativeProcess":{"properties":{"created":{"description":"The timestamp when the operative process was created.","format":"date-time","type":"string"},"entityChildren":{"description":"Entities involved in this operative process represented as a hierarchical tree structure.","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"facilityRef":{"description":"Reference to the facility this operative process is associated with.","type":"string"},"flatEntityRefs":{"description":"Entities involved in this operative process represented as a flat list of entity references.","items":{"minLength":0,"type":"string"},"type":"array"},"id":{"description":"auto generated unique identifier","type":"string"},"isEditable":{"description":"This field indicates if the operative process is editable based on if any of the related pick jobs, service jobs, pack jobs or handover jobs are in progress or have been finished successfully. This field is calculated dynamically on each request.","type":"boolean"},"lastModified":{"description":"The timestamp when the operative process was last modified.","format":"date-time","type":"string"},"processRef":{"description":"Reference to the process this operative process is associated with.","type":"string"},"routingPlanRef":{"description":"Reference to the routing plan this operative process is associated with.","type":"string"},"version":{"description":"The version number of the operative process. This number is incremented each time the operative process is modified.","type":"number"}},"required":["id","version","processRef","facilityRef","flatEntityRefs","entityChildren"],"title":"OperativeProcess","type":"object","description":"OperativeProcess"},"OperativeEntity":{"properties":{"entityChildren":{"description":"Tree structure of entities belonging to this entity","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"entityRef":{"description":"Reference to the full entity","type":"string"},"entityType":{"description":"Type of the entity","enum":["PICK_JOB","PACK_JOB","SHIPMENT","SHIPPING_INFORMATION","HANDOVER_JOB","PARCEL","PARCEL_INFORMATION","SERVICE_JOB","RESTOW_ITEM","ITEM_RETURN_JOB","LINKED_SERVICE_JOBS","PACKING_TARGET_CONTAINER","LOAD_UNIT","SERVICE_CONTAINER","HANDOVER_CONTAINER"],"type":"string"}},"required":["entityRef","entityType"],"title":"OperativeEntity","type":"object","description":"OperativeEntity"},"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"}}}}
```

## The OperativeServiceConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeServiceConfiguration":{"properties":{"cancelReasons":{"description":"Predefined reasons that can be selected when cancelling a service job","items":{"$ref":"#/components/schemas/ServiceJobCancelReason"},"maxItems":50,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"id":{"description":"ID of the Operative Service Configuration is always operativeservice","minLength":1,"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":["created","lastModified","version","id"],"title":"OperativeServiceConfiguration","type":"object","description":"OperativeServiceConfiguration"},"ServiceJobCancelReason":{"properties":{"cancelReasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"description":"Indicates if this cancel reason is currently active and can be selected","type":"boolean"},"cancelReason":{"description":"translated cancelReason selected from cancelReasonLocalized","minLength":1,"type":"string"}},"required":["active","cancelReasonLocalized"],"title":"ServiceJobCancelReason","type":"object","description":"ServiceJobCancelReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OperativeServiceConfigurationForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OperativeServiceConfigurationForUpsert":{"properties":{"cancelReasons":{"description":"Predefined reasons that can be selected when cancelling a service job","items":{"$ref":"#/components/schemas/ServiceJobCancelReason"},"maxItems":50,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms","minimum":1,"type":"integer"}},"required":["version"],"title":"OperativeServiceConfigurationForUpsert","type":"object","description":"OperativeServiceConfigurationForUpsert"},"ServiceJobCancelReason":{"properties":{"cancelReasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"description":"Indicates if this cancel reason is currently active and can be selected","type":"boolean"},"cancelReason":{"description":"translated cancelReason selected from cancelReasonLocalized","minLength":1,"type":"string"}},"required":["active","cancelReasonLocalized"],"title":"ServiceJobCancelReason","type":"object","description":"ServiceJobCancelReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OperativeTransfer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The OptimizationHints object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OptimizationHints":{"properties":{"includeCalculationHints":{"default":false,"description":"Should only be used for debugging. Includes more information on how we calculated the response.","type":"boolean"},"requestedResultCount":{"default":1,"description":"Number of different results we calculated","maximum":20,"type":"integer"}},"type":"object","title":"OptimizationHints","description":"OptimizationHints"}}}}
```

## The Order object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The OrderActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderActionsParameter":{"oneOf":[{"$ref":"#/components/schemas/OrderUnlockActionParameter"},{"$ref":"#/components/schemas/OrderInvalidationActionParameter"},{"$ref":"#/components/schemas/OrderCancelActionParameter"},{"$ref":"#/components/schemas/OrderForceCancelActionParameter"},{"$ref":"#/components/schemas/PromiseConfirmActionParameter"},{"$ref":"#/components/schemas/PromiseExtendActionParameter"},{"$ref":"#/components/schemas/OrderConsumerAddressChangeActionParameter"},{"$ref":"#/components/schemas/OrderConsumerAddressesReplaceActionParameter"}],"title":"OrderActionsParameter","description":"OrderActionsParameter"},"OrderUnlockActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to unlock an order.","properties":{"name":{"enum":["UNLOCK"],"type":"string"},"targetTime":{"description":"Time to be set as a targetTime for the devlivery preferences.","format":"date-time","type":"string"}},"required":["name","version"],"title":"OrderUnlockActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"},"OrderInvalidationActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to Invalidate an order.","properties":{"name":{"enum":["INVALIDATE_PROMISE"],"type":"string"}},"required":["name","version"],"title":"OrderInvalidationActionParameter"},"OrderCancelActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to cancel an order.","properties":{"cancelationReasonId":{"description":"ID of the cancelation reason","type":"string"},"name":{"enum":["CANCEL"],"type":"string"}},"required":["name","version"],"title":"OrderCancelActionParameter"},"OrderForceCancelActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to force cancel an order.","properties":{"name":{"enum":["FORCE_CANCEL"],"type":"string"}},"required":["name","version"],"title":"OrderForceCancelActionParameter"},"PromiseConfirmActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to confirm a promise.","properties":{"name":{"enum":["CONFIRM_PROMISE"],"type":"string"},"tenantOrderId":{"description":"The tenantOrderId to be used for the resulting order","type":"string"}},"required":["name","version"],"title":"PromiseConfirmActionParameter"},"PromiseExtendActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to extend a promise.","properties":{"name":{"enum":["EXTEND_PROMISE"],"type":"string"}},"required":["name","version"],"title":"PromiseExtendActionParameter"},"OrderConsumerAddressChangeActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"deprecated":true,"description":"@deprecated use PATCH /api/orders/:id instead 'Action to change a consumer address of an order, e.g. the postal address.'","properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"consumerAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"name":{"enum":["CHANGE_CONSUMER_ADDRESS"],"type":"string"}},"required":["name","version","consumerAddress","addressType"],"title":"OrderConsumerAddressChangeActionParameter"},"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"},"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"},"maxItems":500,"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"},"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"},"OrderConsumerAddressesReplaceActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"deprecated":true,"description":"@deprecated use PATCH /api/orders/:id instead 'Action to replace all consumer addresses of an order.'","properties":{"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"name":{"enum":["REPLACE_CONSUMER_ADDRESSES"],"type":"string"}},"required":["name","version","consumerAddresses"],"title":"OrderConsumerAddressesReplaceActionParameter"}}}}
```

## The OrderArticleAttributeItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The OrderCancelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderCancelActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to cancel an order.","properties":{"cancelationReasonId":{"description":"ID of the cancelation reason","type":"string"},"name":{"enum":["CANCEL"],"type":"string"}},"required":["name","version"],"title":"OrderCancelActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"}}}}
```

## The OrderCancelationConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderCancelationConfiguration":{"additionalProperties":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This configuration is to define specific rules for canceling orders such as the forced cancelation.","properties":{"allowForceCancelOrder":{"type":"boolean"},"created":{"description":"The date this configuration was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"id":{"type":"string"},"version":{"description":"The version of the configuration to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","allowForceCancelOrder"],"type":"object","title":"OrderCancelationConfiguration"}}}}
```

## The OrderCancellationPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderCancellationPayload":{"properties":{"cancelationReason":{"$ref":"#/components/schemas/CancelationReasonHistoryLog"}},"type":"object","title":"OrderCancellationPayload","description":"OrderCancellationPayload"},"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderCancelledByExpiryEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderCancelledByExpiryEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Order"}},"required":["payload"],"type":"object","title":"OrderCancelledByExpiryEvent","description":"OrderCancelledByExpiryEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The OrderCancelledWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderCancelledWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Order"}},"required":["payload"],"type":"object","title":"OrderCancelledWebHookEvent","description":"OrderCancelledWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The OrderConsumerAddressChangeActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderConsumerAddressChangeActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"deprecated":true,"description":"@deprecated use PATCH /api/orders/:id instead 'Action to change a consumer address of an order, e.g. the postal address.'","properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"consumerAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"name":{"enum":["CHANGE_CONSUMER_ADDRESS"],"type":"string"}},"required":["name","version","consumerAddress","addressType"],"title":"OrderConsumerAddressChangeActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"},"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"},"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"},"maxItems":500,"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"},"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"}}}}
```

## The OrderConsumerAddressesAddressTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"OrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"OrderConsumerAddressesAddressTypeEnumFilter"}}}}
```

## The OrderConsumerAddressesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"OrderConsumerAddressesFilter","type":"object","description":"OrderConsumerAddressesFilter"},"OrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"OrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"OrderConsumerAddressesAddressTypeEnumFilter"},"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"}}}}
```

## The OrderConsumerAddressesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderConsumerAddressesListFilter","type":"object","description":"OrderConsumerAddressesListFilter"},"OrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"OrderConsumerAddressesFilter","type":"object","description":"OrderConsumerAddressesFilter"},"OrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"OrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"OrderConsumerAddressesAddressTypeEnumFilter"},"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"}}}}
```

## The OrderConsumerAddressesReplaceActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderConsumerAddressesReplaceActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"deprecated":true,"description":"@deprecated use PATCH /api/orders/:id instead 'Action to replace all consumer addresses of an order.'","properties":{"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"name":{"enum":["REPLACE_CONSUMER_ADDRESSES"],"type":"string"}},"required":["name","version","consumerAddresses"],"title":"OrderConsumerAddressesReplaceActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"},"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"},"maxItems":500,"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"}}}}
```

## The OrderConsumerFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"OrderConsumerFilter","type":"object","description":"OrderConsumerFilter"},"OrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderConsumerAddressesListFilter","type":"object","description":"OrderConsumerAddressesListFilter"},"OrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"OrderConsumerAddressesFilter","type":"object","description":"OrderConsumerAddressesFilter"},"OrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"OrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"OrderConsumerAddressesAddressTypeEnumFilter"},"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"}}}}
```

## The OrderCreatedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderCreatedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Order"}},"required":["payload"],"type":"object","title":"OrderCreatedWebHookEvent","description":"OrderCreatedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The OrderDeliveryPreferencesCollectFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"OrderDeliveryPreferencesCollectFilter","type":"object","description":"OrderDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"}}}}
```

## The OrderDeliveryPreferencesCollectListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderDeliveryPreferencesCollectListFilter","type":"object","description":"OrderDeliveryPreferencesCollectListFilter"},"OrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"OrderDeliveryPreferencesCollectFilter","type":"object","description":"OrderDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"}}}}
```

## The OrderDeliveryPreferencesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"}},"title":"OrderDeliveryPreferencesFilter","type":"object","description":"OrderDeliveryPreferencesFilter"},"OrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderDeliveryPreferencesCollectListFilter","type":"object","description":"OrderDeliveryPreferencesCollectListFilter"},"OrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"OrderDeliveryPreferencesCollectFilter","type":"object","description":"OrderDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"OrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"OrderDeliveryPreferencesShippingFilter","type":"object","description":"OrderDeliveryPreferencesShippingFilter"},"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"},"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter","type":"object","description":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"}}}}
```

## The OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter","type":"object","description":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"}}}}
```

## The OrderDeliveryPreferencesShippingFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"OrderDeliveryPreferencesShippingFilter","type":"object","description":"OrderDeliveryPreferencesShippingFilter"},"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"},"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter","type":"object","description":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"}}}}
```

## The OrderFenceDecision object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderFenceDecision":{"properties":{"decision":{"$ref":"#/components/schemas/FenceResultStatus"},"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/OrderFenceDecisionDetail"},{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"name":{"type":"string"}},"required":["name","decision","details"],"type":"object","title":"OrderFenceDecision","description":"OrderFenceDecision"},"FenceResultStatus":{"enum":["FAILED","PASSED","REACTIVE_PASSING_POSSIBLE"],"title":"FenceResultStatus","description":"FenceResultStatus"},"OrderFenceDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Order Fence Decision Detail.","properties":{"actualValue":{"type":"string"},"contextReference":{"$ref":"#/components/schemas/ContextReference"},"expectedValue":{"type":"string"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"}},"required":["expectedValue","decisionType"],"title":"OrderFenceDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ContextReference":{"properties":{"reference":{"type":"string"},"routingDecisionContext":{"$ref":"#/components/schemas/RoutingDecisionContext"}},"required":["reference","routingDecisionContext"],"title":"ContextReference","description":"ContextReference"},"RoutingDecisionContext":{"enum":["LISTING","CARRIER"],"title":"RoutingDecisionContext","description":"RoutingDecisionContext"},"ReactiveErrorReason":{"enum":["BACKORDER_LISTING","PREORDER_LISTING"],"title":"ReactiveErrorReason","description":"ReactiveErrorReason"},"ToolkitDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Decision Detail.","properties":{"comparisonOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleOperatorResultExplanation"},"leftPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"leftSideEvaluation":{"type":"boolean"},"rightPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"rightSideEvaluation":{"type":"boolean"}},"required":["decisionType","leftSideEvaluation","description"],"title":"ToolkitDecisionDetail"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitRuleOperatorResultExplanation":{"enum":["SKIPPED","BOTH_CONDITIONS_MET","ONLY_FIRST_CONDITION_MET","ONLY_SECOND_CONDITION_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleOperatorResultExplanation","description":"ToolkitRuleOperatorResultExplanation"},"ToolkitPredicatesDecisionDetail":{"properties":{"connector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicateDecisionDetail"},"type":"array"}},"required":["connector","predicates"],"title":"ToolkitPredicatesDecisionDetail","description":"ToolkitPredicatesDecisionDetail"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitComparisonDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Comparison Decision Detail.","properties":{"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolKitComparisonDetails"},"type":"array"}},"required":["predicates","predicateConnector","description"],"title":"ToolkitComparisonDecisionDetail"},"ToolkitRuleComparePropertiesOperatorResultExplanation":{"enum":["ALL_PREDICATES_MET","NOT_ALL_PREDICATES_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleComparePropertiesOperatorResultExplanation","description":"ToolkitRuleComparePropertiesOperatorResultExplanation"},"ToolKitComparisonDetails":{"properties":{"evaluationResult":{"type":"boolean"},"leftPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"},"predicate":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"rightPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"}},"required":["leftPart","rightPart","evaluationResult","predicate"],"title":"ToolKitComparisonDetails","description":"ToolKitComparisonDetails"},"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"}}}}
```

## The OrderFenceDecisionDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderFenceDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Order Fence Decision Detail.","properties":{"actualValue":{"type":"string"},"contextReference":{"$ref":"#/components/schemas/ContextReference"},"expectedValue":{"type":"string"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"}},"required":["expectedValue","decisionType"],"title":"OrderFenceDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ContextReference":{"properties":{"reference":{"type":"string"},"routingDecisionContext":{"$ref":"#/components/schemas/RoutingDecisionContext"}},"required":["reference","routingDecisionContext"],"title":"ContextReference","description":"ContextReference"},"RoutingDecisionContext":{"enum":["LISTING","CARRIER"],"title":"RoutingDecisionContext","description":"RoutingDecisionContext"},"ReactiveErrorReason":{"enum":["BACKORDER_LISTING","PREORDER_LISTING"],"title":"ReactiveErrorReason","description":"ReactiveErrorReason"}}}}
```

## The OrderForceCancelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderForceCancelActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to force cancel an order.","properties":{"name":{"enum":["FORCE_CANCEL"],"type":"string"}},"required":["name","version"],"title":"OrderForceCancelActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"}}}}
```

## The OrderForceCancelledWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderForceCancelledWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Order"}},"required":["payload"],"type":"object","title":"OrderForceCancelledWebHookEvent","description":"OrderForceCancelledWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The OrderForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The OrderForCreationConsumer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"}}}}
```

## The OrderForSourcingOptionsRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderForSourcingOptionsRequest":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/ConsumerAddressesForSourcingOptions"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"minItems":1,"type":"array"}},"required":["consumer"],"type":"object","xml":{"name":"OrderForSourcingOptionsRequest"},"title":"OrderForSourcingOptionsRequest","description":"OrderForSourcingOptionsRequest"},"ConsumerAddressesForSourcingOptions":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddressForSourcingOptions"},"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"type":"object","title":"ConsumerAddressesForSourcingOptions","description":"ConsumerAddressesForSourcingOptions"},"ConsumerAddressForSourcingOptions":{"additionalProperties":false,"properties":{"additionalAddressInfo":{"type":"string"},"addressType":{"$ref":"#/components/schemas/AddressType"},"city":{"description":"The city of the address.","type":"string"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"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"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/ConsumerAddressForSourcingOptionsPhoneNumber"},"type":"array"},"postalCode":{"description":"The postal code of the address.","type":"string"},"province":{"pattern":"^.+$","type":"string"},"salutation":{"type":"string"},"street":{"description":"The street of the address.","type":"string"}},"required":["country"],"title":"ConsumerAddressForSourcingOptions","description":"ConsumerAddressForSourcingOptions"},"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"},"ConsumerAddressForSourcingOptionsPhoneNumber":{"additionalProperties":false,"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","title":"ConsumerAddressForSourcingOptionsPhoneNumber","description":"ConsumerAddressForSourcingOptionsPhoneNumber"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The OrderForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderForUpdate":{"additionalProperties":false,"properties":{"comment":{"description":"A comment for updating this order.","type":"string"},"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"maxItems":500,"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"title":"OrderForUpdate","description":"OrderForUpdate"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"}}}}
```

## The OrderInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderInformation":{"properties":{"orderDate":{"description":"The date the order was created.","format":"date-time","type":"string"},"orderNumber":{"description":"An identifier for the order.","pattern":"^.+$","type":"string"}},"type":"object","title":"OrderInformation","description":"OrderInformation"}}}}
```

## The OrderInvalidationActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderInvalidationActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to Invalidate an order.","properties":{"name":{"enum":["INVALIDATE_PROMISE"],"type":"string"}},"required":["name","version"],"title":"OrderInvalidationActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"}}}}
```

## The OrderLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The OrderLineItemActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemActionsParameter":{"oneOf":[{"$ref":"#/components/schemas/OrderLineItemCustomAttributesUpdateParameter"}],"type":"object","title":"OrderLineItemActionsParameter","description":"OrderLineItemActionsParameter"},"OrderLineItemCustomAttributesUpdateParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderLineItemActionsParameter"}],"description":"Action to update custom attributes of an order.","properties":{"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. If no customAttributes exist yet, they will be created for this line item.","type":"object"},"name":{"enum":["UPDATE_CUSTOM_ATTRIBUTES"],"type":"string"}},"required":["name","version","customAttributes"],"title":"OrderLineItemCustomAttributesUpdateParameter"},"AbstractOrderLineItemActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the order to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderLineItemActionsParameter","description":"AbstractOrderLineItemActionsParameter"}}}}
```

## The OrderLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The OrderLineItemArticleForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The OrderLineItemCustomAttributesUpdateParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemCustomAttributesUpdateParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderLineItemActionsParameter"}],"description":"Action to update custom attributes of an order.","properties":{"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. If no customAttributes exist yet, they will be created for this line item.","type":"object"},"name":{"enum":["UPDATE_CUSTOM_ATTRIBUTES"],"type":"string"}},"required":["name","version","customAttributes"],"title":"OrderLineItemCustomAttributesUpdateParameter"},"AbstractOrderLineItemActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the order to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderLineItemActionsParameter","description":"AbstractOrderLineItemActionsParameter"}}}}
```

## The OrderLineItemFenceDecision object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemFenceDecision":{"properties":{"articleTitle":{"type":"string"},"decision":{"$ref":"#/components/schemas/FenceResultStatus"},"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/OrderFenceDecisionDetail"},{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","articleTitle","decision","details"],"type":"object","title":"OrderLineItemFenceDecision","description":"OrderLineItemFenceDecision"},"FenceResultStatus":{"enum":["FAILED","PASSED","REACTIVE_PASSING_POSSIBLE"],"title":"FenceResultStatus","description":"FenceResultStatus"},"OrderFenceDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Order Fence Decision Detail.","properties":{"actualValue":{"type":"string"},"contextReference":{"$ref":"#/components/schemas/ContextReference"},"expectedValue":{"type":"string"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"}},"required":["expectedValue","decisionType"],"title":"OrderFenceDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ContextReference":{"properties":{"reference":{"type":"string"},"routingDecisionContext":{"$ref":"#/components/schemas/RoutingDecisionContext"}},"required":["reference","routingDecisionContext"],"title":"ContextReference","description":"ContextReference"},"RoutingDecisionContext":{"enum":["LISTING","CARRIER"],"title":"RoutingDecisionContext","description":"RoutingDecisionContext"},"ReactiveErrorReason":{"enum":["BACKORDER_LISTING","PREORDER_LISTING"],"title":"ReactiveErrorReason","description":"ReactiveErrorReason"},"ToolkitDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Decision Detail.","properties":{"comparisonOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleOperatorResultExplanation"},"leftPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"leftSideEvaluation":{"type":"boolean"},"rightPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"rightSideEvaluation":{"type":"boolean"}},"required":["decisionType","leftSideEvaluation","description"],"title":"ToolkitDecisionDetail"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitRuleOperatorResultExplanation":{"enum":["SKIPPED","BOTH_CONDITIONS_MET","ONLY_FIRST_CONDITION_MET","ONLY_SECOND_CONDITION_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleOperatorResultExplanation","description":"ToolkitRuleOperatorResultExplanation"},"ToolkitPredicatesDecisionDetail":{"properties":{"connector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicateDecisionDetail"},"type":"array"}},"required":["connector","predicates"],"title":"ToolkitPredicatesDecisionDetail","description":"ToolkitPredicatesDecisionDetail"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitComparisonDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Comparison Decision Detail.","properties":{"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolKitComparisonDetails"},"type":"array"}},"required":["predicates","predicateConnector","description"],"title":"ToolkitComparisonDecisionDetail"},"ToolkitRuleComparePropertiesOperatorResultExplanation":{"enum":["ALL_PREDICATES_MET","NOT_ALL_PREDICATES_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleComparePropertiesOperatorResultExplanation","description":"ToolkitRuleComparePropertiesOperatorResultExplanation"},"ToolKitComparisonDetails":{"properties":{"evaluationResult":{"type":"boolean"},"leftPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"},"predicate":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"rightPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"}},"required":["leftPart","rightPart","evaluationResult","predicate"],"title":"ToolKitComparisonDetails","description":"ToolKitComparisonDetails"},"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"}}}}
```

## The OrderLineItemFenceDecisions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemFenceDecisions":{"properties":{"name":{"type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemFenceDecision"},"type":"array"}},"required":["name","orderLineItems"],"title":"OrderLineItemFenceDecisions","description":"OrderLineItemFenceDecisions"},"OrderLineItemFenceDecision":{"properties":{"articleTitle":{"type":"string"},"decision":{"$ref":"#/components/schemas/FenceResultStatus"},"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/OrderFenceDecisionDetail"},{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","articleTitle","decision","details"],"type":"object","title":"OrderLineItemFenceDecision","description":"OrderLineItemFenceDecision"},"FenceResultStatus":{"enum":["FAILED","PASSED","REACTIVE_PASSING_POSSIBLE"],"title":"FenceResultStatus","description":"FenceResultStatus"},"OrderFenceDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Order Fence Decision Detail.","properties":{"actualValue":{"type":"string"},"contextReference":{"$ref":"#/components/schemas/ContextReference"},"expectedValue":{"type":"string"},"reactiveErrorReason":{"$ref":"#/components/schemas/ReactiveErrorReason"}},"required":["expectedValue","decisionType"],"title":"OrderFenceDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ContextReference":{"properties":{"reference":{"type":"string"},"routingDecisionContext":{"$ref":"#/components/schemas/RoutingDecisionContext"}},"required":["reference","routingDecisionContext"],"title":"ContextReference","description":"ContextReference"},"RoutingDecisionContext":{"enum":["LISTING","CARRIER"],"title":"RoutingDecisionContext","description":"RoutingDecisionContext"},"ReactiveErrorReason":{"enum":["BACKORDER_LISTING","PREORDER_LISTING"],"title":"ReactiveErrorReason","description":"ReactiveErrorReason"},"ToolkitDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Decision Detail.","properties":{"comparisonOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleOperatorResultExplanation"},"leftPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"leftSideEvaluation":{"type":"boolean"},"rightPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"rightSideEvaluation":{"type":"boolean"}},"required":["decisionType","leftSideEvaluation","description"],"title":"ToolkitDecisionDetail"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitRuleOperatorResultExplanation":{"enum":["SKIPPED","BOTH_CONDITIONS_MET","ONLY_FIRST_CONDITION_MET","ONLY_SECOND_CONDITION_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleOperatorResultExplanation","description":"ToolkitRuleOperatorResultExplanation"},"ToolkitPredicatesDecisionDetail":{"properties":{"connector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicateDecisionDetail"},"type":"array"}},"required":["connector","predicates"],"title":"ToolkitPredicatesDecisionDetail","description":"ToolkitPredicatesDecisionDetail"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitComparisonDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Comparison Decision Detail.","properties":{"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolKitComparisonDetails"},"type":"array"}},"required":["predicates","predicateConnector","description"],"title":"ToolkitComparisonDecisionDetail"},"ToolkitRuleComparePropertiesOperatorResultExplanation":{"enum":["ALL_PREDICATES_MET","NOT_ALL_PREDICATES_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleComparePropertiesOperatorResultExplanation","description":"ToolkitRuleComparePropertiesOperatorResultExplanation"},"ToolKitComparisonDetails":{"properties":{"evaluationResult":{"type":"boolean"},"leftPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"},"predicate":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"rightPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"}},"required":["leftPart","rightPart","evaluationResult","predicate"],"title":"ToolKitComparisonDetails","description":"ToolKitComparisonDetails"},"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"}}}}
```

## The OrderLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The OrderLineItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The OrderLineItemModifiedLogPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderLineItemModifiedLogPayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"articles":{"description":"List of modified articles","items":{"$ref":"#/components/schemas/ArticleHistoryLog"},"type":"array"}},"title":"OrderLineItemModifiedLogPayload","description":"OrderLineItemModifiedLogPayload"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderModificationConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderModificationConfiguration":{"additionalProperties":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This configuration is to define specific rules for modifying orders after order creation.","properties":{"allowOrderLineItemModification":{"type":"boolean"},"created":{"description":"The date this configuration was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"id":{"type":"string"},"version":{"description":"The version of the configuration to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","allowOrderLineItemModification"],"type":"object","title":"OrderModificationConfiguration"}}}}
```

## The OrderModificationPayloadBase object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"}}}}
```

## The OrderModificationPreferredHandlingTimePayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderModificationPreferredHandlingTimePayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"newPreferredHandlingTime":{"description":"Updated preferredHandlingTime value","format":"date-time","nullable":true,"type":"string"},"previousPreferredHandlingTime":{"description":"preferredHandlingTime value before an update","format":"date-time","nullable":true,"type":"string"}},"required":["previousPreferredHandlingTime","newPreferredHandlingTime"],"title":"OrderModificationPreferredHandlingTimePayload","description":"OrderModificationPreferredHandlingTimePayload"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"}}}}
```

## The OrderModifiedEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderModifiedEventPayload":{"allOf":[{"$ref":"#/components/schemas/Order"}],"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"}},"xml":{"name":"OrderModifiedEventPayload"},"title":"OrderModifiedEventPayload","description":"OrderModifiedEventPayload"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The OrderModifiedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderModifiedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/OrderModifiedEventPayload"}},"required":["payload"],"type":"object","title":"OrderModifiedWebHookEvent","description":"OrderModifiedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"OrderModifiedEventPayload":{"allOf":[{"$ref":"#/components/schemas/Order"}],"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"}},"xml":{"name":"OrderModifiedEventPayload"},"title":"OrderModifiedEventPayload","description":"OrderModifiedEventPayload"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The OrderOrderLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"OrderOrderLineItemsArticleFilter","type":"object","description":"OrderOrderLineItemsArticleFilter"},"OrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"OrderOrderLineItemsArticleTitleLocalizedFilter"},"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"}}}}
```

## The OrderOrderLineItemsArticleTitleLocalizedFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"OrderOrderLineItemsArticleTitleLocalizedFilter"},"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"}}}}
```

## The OrderOrderLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderOrderLineItemsFilter","type":"object","description":"OrderOrderLineItemsFilter"},"OrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"OrderOrderLineItemsArticleFilter","type":"object","description":"OrderOrderLineItemsArticleFilter"},"OrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"OrderOrderLineItemsArticleTitleLocalizedFilter"},"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"}}}}
```

## The OrderOrderLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderOrderLineItemsListFilter","type":"object","description":"OrderOrderLineItemsListFilter"},"OrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderOrderLineItemsFilter","type":"object","description":"OrderOrderLineItemsFilter"},"OrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"OrderOrderLineItemsArticleFilter","type":"object","description":"OrderOrderLineItemsArticleFilter"},"OrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"OrderOrderLineItemsArticleTitleLocalizedFilter"},"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"}}}}
```

## The OrderPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPaginatedResult":{"properties":{"orders":{"items":{"$ref":"#/components/schemas/Order"},"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","orders"],"title":"OrderPaginatedResult","type":"object","description":"OrderPaginatedResult"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"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"}}}}
```

## The OrderPaymentInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderPaymentInfoFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPaymentInfoFilter":{"properties":{"methodLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderPaymentInfoMethodLocalizedFilter"}],"description":"Nested search by methodLocalized"},"currency":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by currency"},"method":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by method"}},"title":"OrderPaymentInfoFilter","type":"object","description":"OrderPaymentInfoFilter"},"OrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderPaymentInfoMethodLocalizedFilter","type":"object","description":"OrderPaymentInfoMethodLocalizedFilter"},"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"}}}}
```

## The OrderPaymentInfoForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderPaymentInfoMethodLocalizedFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderPaymentInfoMethodLocalizedFilter","type":"object","description":"OrderPaymentInfoMethodLocalizedFilter"},"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"}}}}
```

## The OrderPricing object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"}}}}
```

## The OrderPricingDiscount object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"}}}}
```

## The OrderPricingFee object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"}}}}
```

## The OrderPricingForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"}}}}
```

## The OrderPricingTax object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"}}}}
```

## The OrderPricingTotal object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"}}}}
```

## The OrderPricingTotals object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"}}}}
```

## The OrderPromisesOptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"}}}}
```

## The OrderRatingDecision object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRatingDecision":{"properties":{"details":{"items":{"anyOf":[{"$ref":"#/components/schemas/ToolkitDecisionDetail"},{"$ref":"#/components/schemas/ToolkitComparisonDecisionDetail"}]},"type":"array"},"maxPenalty":{"type":"number"},"name":{"type":"string"},"normalizedScore":{"type":"number"},"score":{"type":"number"}},"required":["name","normalizedScore","maxPenalty"],"type":"object","title":"OrderRatingDecision","description":"OrderRatingDecision"},"ToolkitDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Decision Detail.","properties":{"comparisonOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleOperatorResultExplanation"},"leftPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"leftSideEvaluation":{"type":"boolean"},"rightPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"rightSideEvaluation":{"type":"boolean"}},"required":["decisionType","leftSideEvaluation","description"],"title":"ToolkitDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitRuleOperatorResultExplanation":{"enum":["SKIPPED","BOTH_CONDITIONS_MET","ONLY_FIRST_CONDITION_MET","ONLY_SECOND_CONDITION_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleOperatorResultExplanation","description":"ToolkitRuleOperatorResultExplanation"},"ToolkitPredicatesDecisionDetail":{"properties":{"connector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicateDecisionDetail"},"type":"array"}},"required":["connector","predicates"],"title":"ToolkitPredicatesDecisionDetail","description":"ToolkitPredicatesDecisionDetail"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitComparisonDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Comparison Decision Detail.","properties":{"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolKitComparisonDetails"},"type":"array"}},"required":["predicates","predicateConnector","description"],"title":"ToolkitComparisonDecisionDetail"},"ToolkitRuleComparePropertiesOperatorResultExplanation":{"enum":["ALL_PREDICATES_MET","NOT_ALL_PREDICATES_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleComparePropertiesOperatorResultExplanation","description":"ToolkitRuleComparePropertiesOperatorResultExplanation"},"ToolKitComparisonDetails":{"properties":{"evaluationResult":{"type":"boolean"},"leftPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"},"predicate":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"rightPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"}},"required":["leftPart","rightPart","evaluationResult","predicate"],"title":"ToolKitComparisonDetails","description":"ToolKitComparisonDetails"},"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"}}}}
```

## The OrderRecord object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecord":{"properties":{"anonymized":{"description":"Whether consumer data has been anonymized","type":"boolean"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"deletionDate":{"description":"Date when the record will be deleted","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"gdprCleanupDate":{"description":"Date when GDPR cleanup will occur","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItem"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricing"}],"description":"Pricing information including calculated totals"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["orderRecordDate","facilityRef","lineItems","id","version","created","lastModified","anonymized","gdprCleanupDate","deletionDate"],"title":"OrderRecord","type":"object","description":"OrderRecord"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"}}}}
```

## The OrderRecordAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"}}}}
```

## The OrderRecordAddressesSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordAddressesSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"companyName":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"firstName":{"enum":["ASC","DESC"],"type":"string"},"lastName":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordAddressesSort","type":"object","description":"OrderRecordAddressesSort"}}}}
```

## The OrderRecordArticleAttributeItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"}}}}
```

## The OrderRecordBulkOperationError object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordBulkOperationError":{"properties":{"message":{"description":"Error message","type":"string"},"type":{"description":"Error type","enum":["VALIDATION","UNKNOWN"],"type":"string"}},"required":["type","message"],"title":"OrderRecordBulkOperationError","type":"object","description":"OrderRecordBulkOperationError"}}}}
```

## The OrderRecordBulkOperationResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordBulkOperationResult":{"properties":{"error":{"allOf":[{"$ref":"#/components/schemas/OrderRecordBulkOperationError"}],"description":"Error details if the operation failed"},"orderRecord":{"allOf":[{"$ref":"#/components/schemas/OrderRecord"}],"description":"The created order record"},"status":{"description":"Status of the bulk operation","enum":["CREATED","FAILED","UNCHANGED"],"type":"string"}},"required":["status"],"title":"OrderRecordBulkOperationResult","type":"object","description":"OrderRecordBulkOperationResult"},"OrderRecordBulkOperationError":{"properties":{"message":{"description":"Error message","type":"string"},"type":{"description":"Error type","enum":["VALIDATION","UNKNOWN"],"type":"string"}},"required":["type","message"],"title":"OrderRecordBulkOperationError","type":"object","description":"OrderRecordBulkOperationError"},"OrderRecord":{"properties":{"anonymized":{"description":"Whether consumer data has been anonymized","type":"boolean"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"deletionDate":{"description":"Date when the record will be deleted","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"gdprCleanupDate":{"description":"Date when GDPR cleanup will occur","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItem"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricing"}],"description":"Pricing information including calculated totals"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["orderRecordDate","facilityRef","lineItems","id","version","created","lastModified","anonymized","gdprCleanupDate","deletionDate"],"title":"OrderRecord","type":"object","description":"OrderRecord"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"}}}}
```

## The OrderRecordBulkOperations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordBulkOperations":{"properties":{"operations":{"description":"Array of order record creation operations","items":{"$ref":"#/components/schemas/OrderRecordForCreation"},"maxItems":25,"minItems":1,"type":"array"}},"required":["operations"],"title":"OrderRecordBulkOperations","type":"object","description":"OrderRecordBulkOperations"},"OrderRecordForCreation":{"properties":{"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"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"},"facilityRef":{"description":"Reference to the facility","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItemForCreation"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingForCreation"}],"description":"Pricing information for the order record"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"}},"required":["orderRecordDate","facilityRef","lineItems"],"title":"OrderRecordForCreation","type":"object","description":"OrderRecordForCreation"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity"],"title":"OrderRecordLineItemForCreation","type":"object","description":"OrderRecordLineItemForCreation"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricingForCreation":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"}},"title":"OrderRecordPricingForCreation","type":"object","description":"OrderRecordPricingForCreation"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"}}}}
```

## The OrderRecordBulkOperationsResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordBulkOperationsResponse":{"properties":{"details":{"description":"Per-item results of the bulk operation","items":{"$ref":"#/components/schemas/OrderRecordBulkOperationResult"},"maxItems":25,"type":"array"},"summary":{"allOf":[{"$ref":"#/components/schemas/OrderRecordBulkOperationsSummary"}],"description":"Summary of the bulk operation"}},"required":["summary","details"],"title":"OrderRecordBulkOperationsResponse","type":"object","description":"OrderRecordBulkOperationsResponse"},"OrderRecordBulkOperationResult":{"properties":{"error":{"allOf":[{"$ref":"#/components/schemas/OrderRecordBulkOperationError"}],"description":"Error details if the operation failed"},"orderRecord":{"allOf":[{"$ref":"#/components/schemas/OrderRecord"}],"description":"The created order record"},"status":{"description":"Status of the bulk operation","enum":["CREATED","FAILED","UNCHANGED"],"type":"string"}},"required":["status"],"title":"OrderRecordBulkOperationResult","type":"object","description":"OrderRecordBulkOperationResult"},"OrderRecordBulkOperationError":{"properties":{"message":{"description":"Error message","type":"string"},"type":{"description":"Error type","enum":["VALIDATION","UNKNOWN"],"type":"string"}},"required":["type","message"],"title":"OrderRecordBulkOperationError","type":"object","description":"OrderRecordBulkOperationError"},"OrderRecord":{"properties":{"anonymized":{"description":"Whether consumer data has been anonymized","type":"boolean"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"deletionDate":{"description":"Date when the record will be deleted","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"gdprCleanupDate":{"description":"Date when GDPR cleanup will occur","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItem"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricing"}],"description":"Pricing information including calculated totals"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["orderRecordDate","facilityRef","lineItems","id","version","created","lastModified","anonymized","gdprCleanupDate","deletionDate"],"title":"OrderRecord","type":"object","description":"OrderRecord"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"},"OrderRecordBulkOperationsSummary":{"properties":{"created":{"description":"Number of order records created","type":"integer"},"unchanged":{"description":"Number of order records unchanged","type":"integer"},"updated":{"description":"Number of order records updated","type":"integer"}},"required":["created","updated","unchanged"],"title":"OrderRecordBulkOperationsSummary","type":"object","description":"OrderRecordBulkOperationsSummary"}}}}
```

## The OrderRecordBulkOperationsSummary object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordBulkOperationsSummary":{"properties":{"created":{"description":"Number of order records created","type":"integer"},"unchanged":{"description":"Number of order records unchanged","type":"integer"},"updated":{"description":"Number of order records updated","type":"integer"}},"required":["created","updated","unchanged"],"title":"OrderRecordBulkOperationsSummary","type":"object","description":"OrderRecordBulkOperationsSummary"}}}}
```

## The OrderRecordConsumer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"}}}}
```

## The OrderRecordConsumerAddressesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordConsumerAddressesFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"OrderRecordConsumerAddressesFilter","type":"object","description":"OrderRecordConsumerAddressesFilter"},"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"}}}}
```

## The OrderRecordConsumerAddressesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordConsumerAddressesListFilter","type":"object","description":"OrderRecordConsumerAddressesListFilter"},"OrderRecordConsumerAddressesFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"OrderRecordConsumerAddressesFilter","type":"object","description":"OrderRecordConsumerAddressesFilter"},"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"}}}}
```

## The OrderRecordConsumerFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"OrderRecordConsumerFilter","type":"object","description":"OrderRecordConsumerFilter"},"OrderRecordConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordConsumerAddressesListFilter","type":"object","description":"OrderRecordConsumerAddressesListFilter"},"OrderRecordConsumerAddressesFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"OrderRecordConsumerAddressesFilter","type":"object","description":"OrderRecordConsumerAddressesFilter"},"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"}}}}
```

## The OrderRecordConsumerSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordConsumerSort":{"properties":{"addresses":{"$ref":"#/components/schemas/OrderRecordAddressesSort"}},"title":"OrderRecordConsumerSort","type":"object","description":"OrderRecordConsumerSort"},"OrderRecordAddressesSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"companyName":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"firstName":{"enum":["ASC","DESC"],"type":"string"},"lastName":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordAddressesSort","type":"object","description":"OrderRecordAddressesSort"}}}}
```

## The OrderRecordDiscount object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"}}}}
```

## The OrderRecordDiscountBreakdown object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"}}}}
```

## The OrderRecordFee object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"}}}}
```

## The OrderRecordForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordForCreation":{"properties":{"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"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"},"facilityRef":{"description":"Reference to the facility","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItemForCreation"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingForCreation"}],"description":"Pricing information for the order record"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"}},"required":["orderRecordDate","facilityRef","lineItems"],"title":"OrderRecordForCreation","type":"object","description":"OrderRecordForCreation"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity"],"title":"OrderRecordLineItemForCreation","type":"object","description":"OrderRecordLineItemForCreation"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricingForCreation":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"}},"title":"OrderRecordPricingForCreation","type":"object","description":"OrderRecordPricingForCreation"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"}}}}
```

## The OrderRecordLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"}}}}
```

## The OrderRecordLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"}}}}
```

## The OrderRecordLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity"],"title":"OrderRecordLineItemForCreation","type":"object","description":"OrderRecordLineItemForCreation"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"}}}}
```

## The OrderRecordLineItemReturnPolicy object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"}}}}
```

## The OrderRecordLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"OrderRecordLineItemsArticleFilter","type":"object","description":"OrderRecordLineItemsArticleFilter"},"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"}}}}
```

## The OrderRecordLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderRecordLineItemsFilter","type":"object","description":"OrderRecordLineItemsFilter"},"OrderRecordLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"OrderRecordLineItemsArticleFilter","type":"object","description":"OrderRecordLineItemsArticleFilter"},"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"}}}}
```

## The OrderRecordLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordLineItemsListFilter","type":"object","description":"OrderRecordLineItemsListFilter"},"OrderRecordLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderRecordLineItemsFilter","type":"object","description":"OrderRecordLineItemsFilter"},"OrderRecordLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"OrderRecordLineItemsArticleFilter","type":"object","description":"OrderRecordLineItemsArticleFilter"},"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"}}}}
```

## The OrderRecordLineItemsSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItemsSort":{"properties":{"quantity":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordLineItemsSort","type":"object","description":"OrderRecordLineItemsSort"}}}}
```

## The OrderRecordLineItemWarranty object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"}}}}
```

## The OrderRecordMonetaryValue object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"}}}}
```

## The OrderRecordOriginFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordOriginFilter":{"properties":{"cashierId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by cashierId"},"terminalId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by terminalId"}},"title":"OrderRecordOriginFilter","type":"object","description":"OrderRecordOriginFilter"},"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"}}}}
```

## The OrderRecordOriginSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordOriginSort":{"properties":{"cashierId":{"enum":["ASC","DESC"],"type":"string"},"terminalId":{"enum":["ASC","DESC"],"type":"string"},"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordOriginSort","type":"object","description":"OrderRecordOriginSort"}}}}
```

## The OrderRecordPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPaginatedResult":{"properties":{"orderRecords":{"items":{"$ref":"#/components/schemas/OrderRecord"},"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","orderRecords"],"title":"OrderRecordPaginatedResult","type":"object","description":"OrderRecordPaginatedResult"},"OrderRecord":{"properties":{"anonymized":{"description":"Whether consumer data has been anonymized","type":"boolean"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"deletionDate":{"description":"Date when the record will be deleted","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"gdprCleanupDate":{"description":"Date when GDPR cleanup will occur","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItem"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricing"}],"description":"Pricing information including calculated totals"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["orderRecordDate","facilityRef","lineItems","id","version","created","lastModified","anonymized","gdprCleanupDate","deletionDate"],"title":"OrderRecord","type":"object","description":"OrderRecord"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"},"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"}}}}
```

## The OrderRecordPayment object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"}}}}
```

## The OrderRecordPaymentsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPaymentsFilter":{"properties":{"receiptNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by receiptNumber"},"transactionId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by transactionId"}},"title":"OrderRecordPaymentsFilter","type":"object","description":"OrderRecordPaymentsFilter"},"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"}}}}
```

## The OrderRecordPaymentsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPaymentsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPaymentsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordPaymentsListFilter","type":"object","description":"OrderRecordPaymentsListFilter"},"OrderRecordPaymentsFilter":{"properties":{"receiptNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by receiptNumber"},"transactionId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by transactionId"}},"title":"OrderRecordPaymentsFilter","type":"object","description":"OrderRecordPaymentsFilter"},"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"}}}}
```

## The OrderRecordPaymentsSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPaymentsSort":{"properties":{"paymentMethod":{"enum":["ASC","DESC"],"type":"string"},"receiptNumber":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"},"transactionId":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordPaymentsSort","type":"object","description":"OrderRecordPaymentsSort"}}}}
```

## The OrderRecordPosOrigin object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"}}}}
```

## The OrderRecordPricing object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"}}}}
```

## The OrderRecordPricingForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPricingForCreation":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"}},"title":"OrderRecordPricingForCreation","type":"object","description":"OrderRecordPricingForCreation"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"}}}}
```

## The OrderRecordPricingSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPricingSort":{"properties":{"total":{"$ref":"#/components/schemas/OrderRecordTotalSort"}},"title":"OrderRecordPricingSort","type":"object","description":"OrderRecordPricingSort"},"OrderRecordTotalSort":{"properties":{"priceBreakdownTotal":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordTotalSort","type":"object","description":"OrderRecordTotalSort"}}}}
```

## The OrderRecordPricingTotal object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"}}}}
```

## The OrderRecords object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecords":{"properties":{"orderRecords":{"description":"Array of order records","items":{"$ref":"#/components/schemas/OrderRecord"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"number"}},"required":["orderRecords","total"],"title":"OrderRecords","type":"object","description":"OrderRecords"},"OrderRecord":{"properties":{"anonymized":{"description":"Whether consumer data has been anonymized","type":"boolean"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"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"},"deletionDate":{"description":"Date when the record will be deleted","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"gdprCleanupDate":{"description":"Date when GDPR cleanup will occur","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItem"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricing"}],"description":"Pricing information including calculated totals"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["orderRecordDate","facilityRef","lineItems","id","version","created","lastModified","anonymized","gdprCleanupDate","deletionDate"],"title":"OrderRecord","type":"object","description":"OrderRecord"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"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"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"}}}}
```

## The OrderRecordsConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordsConfiguration":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration for the order records functionality.","properties":{"created":{"description":"Creation timestamp.","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record config.","type":"string"},"isOrderRecordsEnabled":{"default":false,"description":"Flag indicating whether order records functionality is enabled.","type":"boolean"},"lastModified":{"description":"Last modification timestamp.","format":"date-time","type":"string"},"version":{"description":"The version of the configuration to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["id","version","isOrderRecordsEnabled"],"title":"OrderRecordsConfiguration","type":"object"}}}}
```

## The OrderRecordsConfigurationInput object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordsConfigurationInput":{"properties":{"isOrderRecordsEnabled":{"default":false,"description":"Flag indicating whether order records functionality is enabled.","type":"boolean"},"version":{"description":"Version number for optimistic locking.","format":"int64","type":"integer"}},"required":["version","isOrderRecordsEnabled"],"title":"OrderRecordsConfigurationInput","type":"object","description":"OrderRecordsConfigurationInput"}}}}
```

## The OrderRecordSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordSearchPayload":{"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/OrderRecordSearchQuery"},"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/OrderRecordSort"},"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":"OrderRecordSearchPayload","type":"object","description":"OrderRecordSearchPayload"},"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"},"OrderRecordSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/OrderRecordSearchQuery"},"maxItems":500,"type":"array"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerFilter"}],"description":"Nested search by consumer"},"facilityName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityName"},"lineItems":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsListFilter"}],"description":"Nested list search by lineItems"},"or":{"items":{"$ref":"#/components/schemas/OrderRecordSearchQuery"},"maxItems":500,"type":"array"},"orderRecordDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by orderRecordDate"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordOriginFilter"}],"description":"Nested search by origin"},"payments":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPaymentsListFilter"}],"description":"Nested list search by payments"},"tenantOrderRecordId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderRecordId"}},"title":"OrderRecordSearchQuery","type":"object","description":"OrderRecordSearchQuery"},"OrderRecordConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"OrderRecordConsumerFilter","type":"object","description":"OrderRecordConsumerFilter"},"OrderRecordConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordConsumerAddressesListFilter","type":"object","description":"OrderRecordConsumerAddressesListFilter"},"OrderRecordConsumerAddressesFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"OrderRecordConsumerAddressesFilter","type":"object","description":"OrderRecordConsumerAddressesFilter"},"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"},"OrderRecordLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordLineItemsListFilter","type":"object","description":"OrderRecordLineItemsListFilter"},"OrderRecordLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderRecordLineItemsFilter","type":"object","description":"OrderRecordLineItemsFilter"},"OrderRecordLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"OrderRecordLineItemsArticleFilter","type":"object","description":"OrderRecordLineItemsArticleFilter"},"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"},"OrderRecordOriginFilter":{"properties":{"cashierId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by cashierId"},"terminalId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by terminalId"}},"title":"OrderRecordOriginFilter","type":"object","description":"OrderRecordOriginFilter"},"OrderRecordPaymentsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPaymentsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordPaymentsListFilter","type":"object","description":"OrderRecordPaymentsListFilter"},"OrderRecordPaymentsFilter":{"properties":{"receiptNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by receiptNumber"},"transactionId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by transactionId"}},"title":"OrderRecordPaymentsFilter","type":"object","description":"OrderRecordPaymentsFilter"},"OrderRecordSort":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderRecordConsumerSort"},"facilityCountry":{"enum":["ASC","DESC"],"type":"string"},"facilityName":{"enum":["ASC","DESC"],"type":"string"},"lineItems":{"$ref":"#/components/schemas/OrderRecordLineItemsSort"},"orderRecordDate":{"enum":["ASC","DESC"],"type":"string"},"origin":{"$ref":"#/components/schemas/OrderRecordOriginSort"},"payments":{"$ref":"#/components/schemas/OrderRecordPaymentsSort"},"pricing":{"$ref":"#/components/schemas/OrderRecordPricingSort"},"tenantOrderRecordId":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordSort","type":"object","description":"OrderRecordSort"},"OrderRecordConsumerSort":{"properties":{"addresses":{"$ref":"#/components/schemas/OrderRecordAddressesSort"}},"title":"OrderRecordConsumerSort","type":"object","description":"OrderRecordConsumerSort"},"OrderRecordAddressesSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"companyName":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"firstName":{"enum":["ASC","DESC"],"type":"string"},"lastName":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordAddressesSort","type":"object","description":"OrderRecordAddressesSort"},"OrderRecordLineItemsSort":{"properties":{"quantity":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordLineItemsSort","type":"object","description":"OrderRecordLineItemsSort"},"OrderRecordOriginSort":{"properties":{"cashierId":{"enum":["ASC","DESC"],"type":"string"},"terminalId":{"enum":["ASC","DESC"],"type":"string"},"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordOriginSort","type":"object","description":"OrderRecordOriginSort"},"OrderRecordPaymentsSort":{"properties":{"paymentMethod":{"enum":["ASC","DESC"],"type":"string"},"receiptNumber":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"},"transactionId":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordPaymentsSort","type":"object","description":"OrderRecordPaymentsSort"},"OrderRecordPricingSort":{"properties":{"total":{"$ref":"#/components/schemas/OrderRecordTotalSort"}},"title":"OrderRecordPricingSort","type":"object","description":"OrderRecordPricingSort"},"OrderRecordTotalSort":{"properties":{"priceBreakdownTotal":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordTotalSort","type":"object","description":"OrderRecordTotalSort"}}}}
```

## The OrderRecordSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/OrderRecordSearchQuery"},"maxItems":500,"type":"array"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerFilter"}],"description":"Nested search by consumer"},"facilityName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityName"},"lineItems":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsListFilter"}],"description":"Nested list search by lineItems"},"or":{"items":{"$ref":"#/components/schemas/OrderRecordSearchQuery"},"maxItems":500,"type":"array"},"orderRecordDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by orderRecordDate"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordOriginFilter"}],"description":"Nested search by origin"},"payments":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPaymentsListFilter"}],"description":"Nested list search by payments"},"tenantOrderRecordId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderRecordId"}},"title":"OrderRecordSearchQuery","type":"object","description":"OrderRecordSearchQuery"},"OrderRecordConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"OrderRecordConsumerFilter","type":"object","description":"OrderRecordConsumerFilter"},"OrderRecordConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordConsumerAddressesListFilter","type":"object","description":"OrderRecordConsumerAddressesListFilter"},"OrderRecordConsumerAddressesFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"OrderRecordConsumerAddressesFilter","type":"object","description":"OrderRecordConsumerAddressesFilter"},"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"},"OrderRecordLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordLineItemsListFilter","type":"object","description":"OrderRecordLineItemsListFilter"},"OrderRecordLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderRecordLineItemsFilter","type":"object","description":"OrderRecordLineItemsFilter"},"OrderRecordLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"OrderRecordLineItemsArticleFilter","type":"object","description":"OrderRecordLineItemsArticleFilter"},"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"},"OrderRecordOriginFilter":{"properties":{"cashierId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by cashierId"},"terminalId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by terminalId"}},"title":"OrderRecordOriginFilter","type":"object","description":"OrderRecordOriginFilter"},"OrderRecordPaymentsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPaymentsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderRecordPaymentsListFilter","type":"object","description":"OrderRecordPaymentsListFilter"},"OrderRecordPaymentsFilter":{"properties":{"receiptNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by receiptNumber"},"transactionId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by transactionId"}},"title":"OrderRecordPaymentsFilter","type":"object","description":"OrderRecordPaymentsFilter"}}}}
```

## The OrderRecordSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordSort":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderRecordConsumerSort"},"facilityCountry":{"enum":["ASC","DESC"],"type":"string"},"facilityName":{"enum":["ASC","DESC"],"type":"string"},"lineItems":{"$ref":"#/components/schemas/OrderRecordLineItemsSort"},"orderRecordDate":{"enum":["ASC","DESC"],"type":"string"},"origin":{"$ref":"#/components/schemas/OrderRecordOriginSort"},"payments":{"$ref":"#/components/schemas/OrderRecordPaymentsSort"},"pricing":{"$ref":"#/components/schemas/OrderRecordPricingSort"},"tenantOrderRecordId":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordSort","type":"object","description":"OrderRecordSort"},"OrderRecordConsumerSort":{"properties":{"addresses":{"$ref":"#/components/schemas/OrderRecordAddressesSort"}},"title":"OrderRecordConsumerSort","type":"object","description":"OrderRecordConsumerSort"},"OrderRecordAddressesSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"companyName":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"firstName":{"enum":["ASC","DESC"],"type":"string"},"lastName":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordAddressesSort","type":"object","description":"OrderRecordAddressesSort"},"OrderRecordLineItemsSort":{"properties":{"quantity":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordLineItemsSort","type":"object","description":"OrderRecordLineItemsSort"},"OrderRecordOriginSort":{"properties":{"cashierId":{"enum":["ASC","DESC"],"type":"string"},"terminalId":{"enum":["ASC","DESC"],"type":"string"},"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordOriginSort","type":"object","description":"OrderRecordOriginSort"},"OrderRecordPaymentsSort":{"properties":{"paymentMethod":{"enum":["ASC","DESC"],"type":"string"},"receiptNumber":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"},"transactionId":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordPaymentsSort","type":"object","description":"OrderRecordPaymentsSort"},"OrderRecordPricingSort":{"properties":{"total":{"$ref":"#/components/schemas/OrderRecordTotalSort"}},"title":"OrderRecordPricingSort","type":"object","description":"OrderRecordPricingSort"},"OrderRecordTotalSort":{"properties":{"priceBreakdownTotal":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordTotalSort","type":"object","description":"OrderRecordTotalSort"}}}}
```

## The OrderRecordTax object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"}}}}
```

## The OrderRecordTotalDiscounts object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"}}}}
```

## The OrderRecordTotals object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"}}}}
```

## The OrderRecordTotalSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRecordTotalSort":{"properties":{"priceBreakdownTotal":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderRecordTotalSort","type":"object","description":"OrderRecordTotalSort"}}}}
```

## The OrderRoutingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderRoutingConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"},"infiniteStockEnabled":{"description":"Config to enable/disable infinite stock","type":"boolean"}},"type":"object","title":"OrderRoutingConfiguration","description":"OrderRoutingConfiguration"},"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"}}}}
```

## The OrderSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSearchPayload":{"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/OrderSearchQuery"},"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/OrderSort"},"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":"OrderSearchPayload","type":"object","description":"OrderSearchPayload"},"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"},"OrderSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/OrderSearchQuery"},"maxItems":500,"type":"array"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerFilter"}],"description":"Nested search by consumer"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"deliveryPreferences":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesFilter"}],"description":"Nested search by deliveryPreferences"},"or":{"items":{"$ref":"#/components/schemas/OrderSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"orderLineItems":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsListFilter"}],"description":"Nested list search by orderLineItems"},"paymentInfo":{"allOf":[{"$ref":"#/components/schemas/OrderPaymentInfoFilter"}],"description":"Nested search by paymentInfo"},"status":{"allOf":[{"$ref":"#/components/schemas/OrderStatusEnumFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"},"tags":{"allOf":[{"$ref":"#/components/schemas/OrderTagsListFilter"}],"description":"Nested list search by tags"}},"title":"OrderSearchQuery","type":"object","description":"OrderSearchQuery"},"OrderConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"OrderConsumerFilter","type":"object","description":"OrderConsumerFilter"},"OrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderConsumerAddressesListFilter","type":"object","description":"OrderConsumerAddressesListFilter"},"OrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"OrderConsumerAddressesFilter","type":"object","description":"OrderConsumerAddressesFilter"},"OrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"OrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"OrderConsumerAddressesAddressTypeEnumFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"OrderDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"}},"title":"OrderDeliveryPreferencesFilter","type":"object","description":"OrderDeliveryPreferencesFilter"},"OrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderDeliveryPreferencesCollectListFilter","type":"object","description":"OrderDeliveryPreferencesCollectListFilter"},"OrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"OrderDeliveryPreferencesCollectFilter","type":"object","description":"OrderDeliveryPreferencesCollectFilter"},"OrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"OrderDeliveryPreferencesShippingFilter","type":"object","description":"OrderDeliveryPreferencesShippingFilter"},"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter","type":"object","description":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"},"OrderOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderOrderLineItemsListFilter","type":"object","description":"OrderOrderLineItemsListFilter"},"OrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderOrderLineItemsFilter","type":"object","description":"OrderOrderLineItemsFilter"},"OrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"OrderOrderLineItemsArticleFilter","type":"object","description":"OrderOrderLineItemsArticleFilter"},"OrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"OrderOrderLineItemsArticleTitleLocalizedFilter"},"OrderPaymentInfoFilter":{"properties":{"methodLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderPaymentInfoMethodLocalizedFilter"}],"description":"Nested search by methodLocalized"},"currency":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by currency"},"method":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by method"}},"title":"OrderPaymentInfoFilter","type":"object","description":"OrderPaymentInfoFilter"},"OrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderPaymentInfoMethodLocalizedFilter","type":"object","description":"OrderPaymentInfoMethodLocalizedFilter"},"OrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"OrderStatusEnumFilter","type":"object","description":"OrderStatusEnumFilter"},"OrderTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderTagsListFilter","type":"object","description":"OrderTagsListFilter"},"OrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"OrderTagsFilter","type":"object","description":"OrderTagsFilter"},"OrderSort":{"properties":{"orderDate":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderSort","type":"object","description":"OrderSort"}}}}
```

## The OrderSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/OrderSearchQuery"},"maxItems":500,"type":"array"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerFilter"}],"description":"Nested search by consumer"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"deliveryPreferences":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesFilter"}],"description":"Nested search by deliveryPreferences"},"or":{"items":{"$ref":"#/components/schemas/OrderSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"orderLineItems":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsListFilter"}],"description":"Nested list search by orderLineItems"},"paymentInfo":{"allOf":[{"$ref":"#/components/schemas/OrderPaymentInfoFilter"}],"description":"Nested search by paymentInfo"},"status":{"allOf":[{"$ref":"#/components/schemas/OrderStatusEnumFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"},"tags":{"allOf":[{"$ref":"#/components/schemas/OrderTagsListFilter"}],"description":"Nested list search by tags"}},"title":"OrderSearchQuery","type":"object","description":"OrderSearchQuery"},"OrderConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"OrderConsumerFilter","type":"object","description":"OrderConsumerFilter"},"OrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderConsumerAddressesListFilter","type":"object","description":"OrderConsumerAddressesListFilter"},"OrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"OrderConsumerAddressesFilter","type":"object","description":"OrderConsumerAddressesFilter"},"OrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"OrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"OrderConsumerAddressesAddressTypeEnumFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"OrderDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"}},"title":"OrderDeliveryPreferencesFilter","type":"object","description":"OrderDeliveryPreferencesFilter"},"OrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderDeliveryPreferencesCollectListFilter","type":"object","description":"OrderDeliveryPreferencesCollectListFilter"},"OrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"OrderDeliveryPreferencesCollectFilter","type":"object","description":"OrderDeliveryPreferencesCollectFilter"},"OrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"OrderDeliveryPreferencesShippingFilter","type":"object","description":"OrderDeliveryPreferencesShippingFilter"},"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter","type":"object","description":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"},"OrderOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderOrderLineItemsListFilter","type":"object","description":"OrderOrderLineItemsListFilter"},"OrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderOrderLineItemsFilter","type":"object","description":"OrderOrderLineItemsFilter"},"OrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"OrderOrderLineItemsArticleFilter","type":"object","description":"OrderOrderLineItemsArticleFilter"},"OrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"OrderOrderLineItemsArticleTitleLocalizedFilter"},"OrderPaymentInfoFilter":{"properties":{"methodLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderPaymentInfoMethodLocalizedFilter"}],"description":"Nested search by methodLocalized"},"currency":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by currency"},"method":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by method"}},"title":"OrderPaymentInfoFilter","type":"object","description":"OrderPaymentInfoFilter"},"OrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderPaymentInfoMethodLocalizedFilter","type":"object","description":"OrderPaymentInfoMethodLocalizedFilter"},"OrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"OrderStatusEnumFilter","type":"object","description":"OrderStatusEnumFilter"},"OrderTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderTagsListFilter","type":"object","description":"OrderTagsListFilter"},"OrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"OrderTagsFilter","type":"object","description":"OrderTagsFilter"}}}}
```

## The OrderSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSort":{"properties":{"orderDate":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderSort","type":"object","description":"OrderSort"}}}}
```

## The OrderSourceConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSourceConfiguration":{"additionalProperties":false,"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This configuration is to define possible sources of an order","properties":{"created":{"description":"The date this configuration was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"description":"The date the config was modified last. This value is generated by the service.","format":"date-time","type":"string"},"orderSources":{"items":{"$ref":"#/components/schemas/OrderSourceEntry"},"maxItems":500,"minItems":0,"type":"array"},"version":{"description":"The version of the configuration to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"OrderSourceConfiguration"},"OrderSourceEntry":{"additionalProperties":false,"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Possible source of an order","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"name":{"type":"string"},"tenantSourceId":{"type":"string"},"version":{"type":"integer"}},"required":["nameLocalized","version","id"],"type":"object","title":"OrderSourceEntry"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderSourceEntry object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSourceEntry":{"additionalProperties":false,"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Possible source of an order","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"name":{"type":"string"},"tenantSourceId":{"type":"string"},"version":{"type":"integer"}},"required":["nameLocalized","version","id"],"type":"object","title":"OrderSourceEntry"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderSourceEntryForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSourceEntryForCreation":{"additionalProperties":false,"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Possible source of an order","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"tenantSourceId":{"type":"string"}},"required":["nameLocalized"],"type":"object","title":"OrderSourceEntryForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderSourceEntryForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSourceEntryForUpdate":{"additionalProperties":false,"description":"Possible source of an order, used for update operations, where the version is required for optimistic locking","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"tenantSourceId":{"type":"string"},"version":{"type":"integer"}},"required":["nameLocalized","version"],"type":"object","title":"OrderSourceEntryForUpdate"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderSplit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSplit":{"additionalProperties":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","properties":{"active":{"default":false,"type":"boolean"},"activeForSameDay":{"default":false,"type":"boolean"},"fixedCountConfiguration":{"$ref":"#/components/schemas/FixedCountConfiguration"},"orderSplitType":{"$ref":"#/components/schemas/OrderSplitType"},"shouldUseWaitingRoomForPreBackOrderItems":{"default":false,"type":"boolean"}},"required":["active","orderSplitType"],"type":"object","title":"OrderSplit"},"FixedCountConfiguration":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration of fixed count split.","properties":{"maxSplitCount":{"description":"This setting defines how often an order split might be performed to fulfill the order.","minimum":1,"type":"number"}},"required":["maxSplitCount"],"type":"object","title":"FixedCountConfiguration"},"OrderSplitType":{"description":"The type of order split","enum":["FIXED_COUNT"],"type":"string","xml":{"name":"OrderSplitType"},"title":"OrderSplitType"}}}}
```

## The OrderSplitDecision object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSplitDecision":{"properties":{"reassignment":{"$ref":"#/components/schemas/ReassignmentInformation"},"split":{"$ref":"#/components/schemas/SplitInformation"},"splitType":{"$ref":"#/components/schemas/SplitResultType"}},"required":["splitType"],"title":"OrderSplitDecision","description":"OrderSplitDecision"},"ReassignmentInformation":{"properties":{"reassignedItems":{"items":{"$ref":"#/components/schemas/AssignmentItem"},"type":"array"},"sourceFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"}},"required":["sourceFacility","reassignedItems"],"title":"ReassignmentInformation","description":"ReassignmentInformation"},"AssignmentItem":{"properties":{"articleTitle":{"type":"string"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"AssignmentItem","description":"AssignmentItem"},"DecisionLogFacilityInfo":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"required":["name","facilityRef"],"title":"DecisionLogFacilityInfo","description":"DecisionLogFacilityInfo"},"SplitInformation":{"properties":{"splitCount":{"type":"number"},"splittedItems":{"items":{"$ref":"#/components/schemas/AssignmentItem"},"type":"array"},"targetFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"targetRoutingPlanRef":{"type":"string"}},"required":["splitCount","targetRoutingPlanRef","splittedItems"],"title":"SplitInformation","description":"SplitInformation"},"SplitResultType":{"enum":["SPLIT","DO_NOT_SPLIT","DO_NOT_SPLIT_USE_BEST_RATED","DO_NOT_SPLIT_BECAUSE_AVAILABILITY_USE_BEST_RATED","DO_NOT_SPLIT_USE_BEST_AVAILABLE","REASSIGN_TO_PARENT","REASSIGN_TO_PARENT_COMPLETELY","FAIL","INVALID_SPLIT","PARK_IN_WAITING_ROOM"],"title":"SplitResultType","description":"SplitResultType"}}}}
```

## The OrderSplitType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderSplitType":{"description":"The type of order split","enum":["FIXED_COUNT"],"type":"string","xml":{"name":"OrderSplitType"},"title":"OrderSplitType"}}}}
```

## The OrderStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"}}}}
```

## The OrderStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"OrderStatusEnumFilter","type":"object","description":"OrderStatusEnumFilter"}}}}
```

## The OrderStatusReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"}}}}
```

## The OrderStatusReasonLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"}}}}
```

## The OrderTagConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"title":"OrderTagConfiguration","description":"OrderTagConfiguration"},"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"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The OrderTagsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"OrderTagsFilter","type":"object","description":"OrderTagsFilter"},"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"}}}}
```

## The OrderTagsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderTagsListFilter","type":"object","description":"OrderTagsListFilter"},"OrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"OrderTagsFilter","type":"object","description":"OrderTagsFilter"},"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"}}}}
```

## The OrderTotalDiscounts object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"}}}}
```

## The OrderUnlockActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderUnlockActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to unlock an order.","properties":{"name":{"enum":["UNLOCK"],"type":"string"},"targetTime":{"description":"Time to be set as a targetTime for the devlivery preferences.","format":"date-time","type":"string"}},"required":["name","version"],"title":"OrderUnlockActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"}}}}
```

## The OrderUnlockedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderUnlockedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Order"}},"required":["payload"],"type":"object","title":"OrderUnlockedWebHookEvent","description":"OrderUnlockedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"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"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The OrderUpdateDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The OrderUpdateDetailChanges object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"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. Ensure that no authentication is needed 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":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The OutboundClearTrigger object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutboundClearTrigger":{"properties":{"event":{"enum":["pick-job-closed_event-v1","handoverjob-handed-over_event-v1"],"type":"string"},"tagFilter":{"items":{"$ref":"#/components/schemas/OutboundTagFilter"},"type":"array"}},"required":["event"],"title":"OutboundClearTrigger","type":"object","description":"OutboundClearTrigger"},"OutboundTagFilter":{"properties":{"allowedValues":{"items":{"type":"string"},"type":"array"},"tagId":{"type":"string"}},"required":["allowedValues","tagId"],"title":"OutboundTagFilter","type":"object","description":"OutboundTagFilter"}}}}
```

## The OutboundStockConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutboundStockConfiguration":{"properties":{"clearTrigger":{"items":{"$ref":"#/components/schemas/OutboundClearTrigger"},"type":"array"},"locationRef":{"type":"string"},"trackOutboundStock":{"type":"boolean"}},"required":["trackOutboundStock","locationRef"],"title":"OutboundStockConfiguration","type":"object","description":"OutboundStockConfiguration"},"OutboundClearTrigger":{"properties":{"event":{"enum":["pick-job-closed_event-v1","handoverjob-handed-over_event-v1"],"type":"string"},"tagFilter":{"items":{"$ref":"#/components/schemas/OutboundTagFilter"},"type":"array"}},"required":["event"],"title":"OutboundClearTrigger","type":"object","description":"OutboundClearTrigger"},"OutboundTagFilter":{"properties":{"allowedValues":{"items":{"type":"string"},"type":"array"},"tagId":{"type":"string"}},"required":["allowedValues","tagId"],"title":"OutboundTagFilter","type":"object","description":"OutboundTagFilter"}}}}
```

## The OutboundTagFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutboundTagFilter":{"properties":{"allowedValues":{"items":{"type":"string"},"type":"array"},"tagId":{"type":"string"}},"required":["allowedValues","tagId"],"title":"OutboundTagFilter","type":"object","description":"OutboundTagFilter"}}}}
```

## The OutOfStockBehaviour object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"}}}}
```

## The OutOfStockBehaviourByContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"}}}}
```

## The OutOfStockBehaviourByContext2 object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutOfStockBehaviourByContext2":{"properties":{"context":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext"},"maxItems":5,"minItems":1,"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig2"},"priority":{"type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"OutOfStockBehaviourByContext2","type":"object","description":"OutOfStockBehaviourByContext2"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockConfig2":{"properties":{"preorder":{"$ref":"#/components/schemas/OutOfStockConfigPreorder2"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"OutOfStockConfig2","type":"object","description":"OutOfStockConfig2"},"OutOfStockConfigPreorder2":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/AvailabilityTimeframe2"}]}},"required":["availabilityTimeframe"],"title":"OutOfStockConfigPreorder2","type":"object","description":"OutOfStockConfigPreorder2"},"AvailabilityTimeframe2":{"properties":{"start":{"type":"string"}},"required":["start"],"title":"AvailabilityTimeframe2","type":"object","description":"AvailabilityTimeframe2"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"}}}}
```

## The OutOfStockBehaviourContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"}}}}
```

## The OutOfStockBehaviourContextType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"}}}}
```

## The OutOfStockConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"}}}}
```

## The OutOfStockConfig2 object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutOfStockConfig2":{"properties":{"preorder":{"$ref":"#/components/schemas/OutOfStockConfigPreorder2"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"OutOfStockConfig2","type":"object","description":"OutOfStockConfig2"},"OutOfStockConfigPreorder2":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/AvailabilityTimeframe2"}]}},"required":["availabilityTimeframe"],"title":"OutOfStockConfigPreorder2","type":"object","description":"OutOfStockConfigPreorder2"},"AvailabilityTimeframe2":{"properties":{"start":{"type":"string"}},"required":["start"],"title":"AvailabilityTimeframe2","type":"object","description":"AvailabilityTimeframe2"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"}}}}
```

## The OutOfStockConfigPreorder2 object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OutOfStockConfigPreorder2":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/AvailabilityTimeframe2"}]}},"required":["availabilityTimeframe"],"title":"OutOfStockConfigPreorder2","type":"object","description":"OutOfStockConfigPreorder2"},"AvailabilityTimeframe2":{"properties":{"start":{"type":"string"}},"required":["start"],"title":"AvailabilityTimeframe2","type":"object","description":"AvailabilityTimeframe2"}}}}
```

## The OverflowCostDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The PackageCost object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The PackagingPricingDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingPricingDetails":{"properties":{"costCoefficient":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitCostCoefficient"}],"description":"Cost coefficient for two-man handling"},"pricing":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricingByZone"},"maxItems":500,"type":"array"},"surchargesPerPackagingUnits":{"description":"The surcharge applied per packagingUnit.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackagingUnitDetailRelativeSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"}]},"maxItems":500,"type":"array"}},"required":["pricing"],"title":"PackagingPricingDetails","type":"object","description":"PackagingPricingDetails"},"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"}}}}
```

## The PackagingUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The PackagingUnitContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"}}}}
```

## The PackagingUnitContextTypes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"}}}}
```

## The PackagingUnitCostCoefficient object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"}}}}
```

## The PackagingUnitDetailAbsoluteSurcharge object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"}}}}
```

## The PackagingUnitDetailDimensions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailDimensions":{"properties":{"maxHeight":{"description":"The max height of the packagingUnit in millimeters.","type":"number"},"maxLength":{"description":"The max length of the packagingUnit in millimeters.","type":"number"},"maxWidth":{"description":"The max width of the packagingUnit in millimeters.","type":"number"}},"required":["maxHeight","maxLength","maxWidth"],"title":"PackagingUnitDetailDimensions","type":"object","description":"PackagingUnitDetailDimensions"}}}}
```

## The PackagingUnitDetailForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"carrierRef":{"description":"The reference to the carrier associated with the packagingUnit.","type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/PalletDetails"},{"$ref":"#/components/schemas/ParcelDetails"},{"$ref":"#/components/schemas/BulkyGoodsDetails"},{"$ref":"#/components/schemas/TwoManHandlingDetails"},{"$ref":"#/components/schemas/LongGoodsDetails"}]},"tenantPackagingUnitId":{"description":"The tenant specific identifier for the packagingUnit.","type":"string"}},"required":["nameLocalized","tenantPackagingUnitId","carrierRef","details"],"title":"PackagingUnitDetailForCreation","type":"object","description":"PackagingUnitDetailForCreation"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"PalletDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"loadCarrierHeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The height in millimeters of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"loadCarrierWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The tare weight in grams of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolumetricWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The maximum volumetric weight the packagingUnit can hold, as a feasibility cap.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","dimensions","maxWeight","volumetricWeightFactor","packagingPricingDetails"],"title":"PalletDetails","type":"object","description":"PalletDetails"},"PackagingUnitDetailDimensions":{"properties":{"maxHeight":{"description":"The max height of the packagingUnit in millimeters.","type":"number"},"maxLength":{"description":"The max length of the packagingUnit in millimeters.","type":"number"},"maxWidth":{"description":"The max width of the packagingUnit in millimeters.","type":"number"}},"required":["maxHeight","maxLength","maxWidth"],"title":"PackagingUnitDetailDimensions","type":"object","description":"PackagingUnitDetailDimensions"},"PackagingPricingDetails":{"properties":{"costCoefficient":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitCostCoefficient"}],"description":"Cost coefficient for two-man handling"},"pricing":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricingByZone"},"maxItems":500,"type":"array"},"surchargesPerPackagingUnits":{"description":"The surcharge applied per packagingUnit.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackagingUnitDetailRelativeSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"}]},"maxItems":500,"type":"array"}},"required":["pricing"],"title":"PackagingPricingDetails","type":"object","description":"PackagingPricingDetails"},"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"},"PackagingUnitPricingBasis":{"properties":{"pricingQuantities":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","items":{"$ref":"#/components/schemas/PackagingUnitPricingQuantity"},"maxItems":3,"type":"array"},"pricingUnit":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingUnit"}],"description":"The unit the pricing quantities are converted to and priced in."}},"required":["pricingUnit","pricingQuantities"],"title":"PackagingUnitPricingBasis","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />PackagingUnitPricingBasis"},"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"},"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"ParcelDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolumetricWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The maximum volumetric weight the packagingUnit can hold, as a feasibility cap.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","dimensions","maxWeight","packagingPricingDetails"],"title":"ParcelDetails","type":"object","description":"ParcelDetails"},"BulkyGoodsDetails":{"properties":{"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxGirth":{"description":"The maximum girth in millimeters of the packagingUnit.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxLength":{"description":"The maximum length in millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","maxLength","maxGirth","maxWeight","packagingPricingDetails"],"title":"BulkyGoodsDetails","type":"object","description":"BulkyGoodsDetails"},"TwoManHandlingDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolume":{"description":"The maximum volume in cubicle millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"},"weightToVolumeFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The factor converting the weight of the packagingUnit to an equivalent volume.","type":"number"}},"required":["type","dimensions","maxWeight","packagingPricingDetails"],"title":"TwoManHandlingDetails","type":"object","description":"TwoManHandlingDetails"},"LongGoodsDetails":{"properties":{"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"loadCarrierHeight":{"description":"The height in millimeters of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"loadCarrierWeight":{"description":"The tare weight in grams of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"maxGirth":{"description":"The maximum girth in millimeters of the packagingUnit.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxLength":{"description":"The maximum length in millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"type":"string"},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","packagingPricingDetails"],"title":"LongGoodsDetails","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />LongGoodsDetails"}}}}
```

## The PackagingUnitDetailForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailForUpdate":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"carrierRef":{"description":"The reference to the carrier associated with the packagingUnit.","type":"string"},"details":{"anyOf":[{"$ref":"#/components/schemas/PalletDetails"},{"$ref":"#/components/schemas/ParcelDetails"},{"$ref":"#/components/schemas/BulkyGoodsDetails"},{"$ref":"#/components/schemas/TwoManHandlingDetails"},{"$ref":"#/components/schemas/LongGoodsDetails"}]},"tenantPackagingUnitId":{"description":"The tenant specific identifier for the packagingUnit.","type":"string"},"version":{"description":"The version of the packagingUnit.","type":"number"}},"required":["nameLocalized","tenantPackagingUnitId","carrierRef","details","version"],"title":"PackagingUnitDetailForUpdate","type":"object","description":"PackagingUnitDetailForUpdate"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"PalletDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"loadCarrierHeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The height in millimeters of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"loadCarrierWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The tare weight in grams of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolumetricWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The maximum volumetric weight the packagingUnit can hold, as a feasibility cap.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","dimensions","maxWeight","volumetricWeightFactor","packagingPricingDetails"],"title":"PalletDetails","type":"object","description":"PalletDetails"},"PackagingUnitDetailDimensions":{"properties":{"maxHeight":{"description":"The max height of the packagingUnit in millimeters.","type":"number"},"maxLength":{"description":"The max length of the packagingUnit in millimeters.","type":"number"},"maxWidth":{"description":"The max width of the packagingUnit in millimeters.","type":"number"}},"required":["maxHeight","maxLength","maxWidth"],"title":"PackagingUnitDetailDimensions","type":"object","description":"PackagingUnitDetailDimensions"},"PackagingPricingDetails":{"properties":{"costCoefficient":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitCostCoefficient"}],"description":"Cost coefficient for two-man handling"},"pricing":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricingByZone"},"maxItems":500,"type":"array"},"surchargesPerPackagingUnits":{"description":"The surcharge applied per packagingUnit.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackagingUnitDetailRelativeSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"}]},"maxItems":500,"type":"array"}},"required":["pricing"],"title":"PackagingPricingDetails","type":"object","description":"PackagingPricingDetails"},"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"},"PackagingUnitPricingBasis":{"properties":{"pricingQuantities":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","items":{"$ref":"#/components/schemas/PackagingUnitPricingQuantity"},"maxItems":3,"type":"array"},"pricingUnit":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingUnit"}],"description":"The unit the pricing quantities are converted to and priced in."}},"required":["pricingUnit","pricingQuantities"],"title":"PackagingUnitPricingBasis","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />PackagingUnitPricingBasis"},"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"},"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"},"ParcelDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolumetricWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The maximum volumetric weight the packagingUnit can hold, as a feasibility cap.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","dimensions","maxWeight","packagingPricingDetails"],"title":"ParcelDetails","type":"object","description":"ParcelDetails"},"BulkyGoodsDetails":{"properties":{"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxGirth":{"description":"The maximum girth in millimeters of the packagingUnit.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxLength":{"description":"The maximum length in millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","maxLength","maxGirth","maxWeight","packagingPricingDetails"],"title":"BulkyGoodsDetails","type":"object","description":"BulkyGoodsDetails"},"TwoManHandlingDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolume":{"description":"The maximum volume in cubicle millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"},"weightToVolumeFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The factor converting the weight of the packagingUnit to an equivalent volume.","type":"number"}},"required":["type","dimensions","maxWeight","packagingPricingDetails"],"title":"TwoManHandlingDetails","type":"object","description":"TwoManHandlingDetails"},"LongGoodsDetails":{"properties":{"ldmToWeightFactor":{"description":"The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"loadCarrierHeight":{"description":"The height in millimeters of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"loadCarrierWeight":{"description":"The tare weight in grams of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"maxGirth":{"description":"The maximum girth in millimeters of the packagingUnit.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxLength":{"description":"The maximum length in millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"type":"string"},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","packagingPricingDetails"],"title":"LongGoodsDetails","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />LongGoodsDetails"}}}}
```

## The PackagingUnitDetailOverflowFactor object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"}}}}
```

## The PackagingUnitDetailPricesByWeight object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"}}}}
```

## The PackagingUnitDetailPricingByZone object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"}}}}
```

## The PackagingUnitDetailRelativeSurcharge object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"}}}}
```

## The PackagingUnitDetailThresholdSurcharge object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"}}}}
```

## The PackagingUnitDimensions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"}}}}
```

## The PackagingUnitPricingBasis object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitPricingBasis":{"properties":{"pricingQuantities":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","items":{"$ref":"#/components/schemas/PackagingUnitPricingQuantity"},"maxItems":3,"type":"array"},"pricingUnit":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingUnit"}],"description":"The unit the pricing quantities are converted to and priced in."}},"required":["pricingUnit","pricingQuantities"],"title":"PackagingUnitPricingBasis","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />PackagingUnitPricingBasis"},"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"},"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"}}}}
```

## The PackagingUnitPricingQuantity object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"}}}}
```

## The PackagingUnitPricingUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"}}}}
```

## The PackagingUnitsByContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitsByContext":{"additionalProperties":false,"properties":{"context":{"items":{"$ref":"#/components/schemas/PackagingUnitContext"},"maxItems":500,"minItems":0,"type":"array"},"packagingUnits":{"items":{"$ref":"#/components/schemas/PackagingUnit"},"maxItems":500,"minItems":1,"type":"array"}},"required":["context","packagingUnits"],"type":"object","title":"PackagingUnitsByContext","description":"PackagingUnitsByContext"},"PackagingUnitContext":{"additionalProperties":false,"properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/PackagingUnitContextTypes"},"values":{"items":{"maxItems":500,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"PackagingUnitContext","description":"PackagingUnitContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"PackagingUnitContextTypes":{"enum":["TARGET_POSTALCODE","TARGET_COUNTRY","CATEGORY"],"type":"string","title":"PackagingUnitContextTypes","description":"PackagingUnitContextTypes"},"PackagingUnit":{"additionalProperties":false,"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum item quantity of the packaging unit","minimum":0,"type":"integer"},"name":{"description":"The name of the packaging unit","type":"string"},"packagingUnitRef":{"description":"The reference ID of the packaging unit","type":"string"},"prices":{"items":{"$ref":"#/components/schemas/InterFacilityConnectionDeliveryCost"},"type":"array"},"priority":{"description":"The priority of the packaging unit. Lowest value has the highest priority. Must be unique per context","minimum":0,"type":"integer"},"tenantPackagingUnitId":{"description":"The tenant-specific ID of the packaging unit","type":"string"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer of PackagingUnit in percent","minimum":0,"type":"integer"}},"required":["name","priority"],"type":"object","title":"PackagingUnit","description":"PackagingUnit"},"PackagingUnitDimensions":{"additionalProperties":false,"properties":{"height":{"description":"The height of the packaging unit","minimum":0,"type":"number"},"length":{"description":"The length of the packaging unit","minimum":0,"type":"number"},"maxWeightInGram":{"description":"The weight of the packaging unit","minimum":0,"type":"number"},"width":{"description":"The width of the packaging unit","minimum":0,"type":"number"}},"required":["length","width","height","maxWeightInGram"],"type":"object","title":"PackagingUnitDimensions","description":"PackagingUnitDimensions"},"InterFacilityConnectionDeliveryCost":{"additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"deliveryCostCoefficient":{"$ref":"#/components/schemas/DeliverCostCoefficient"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"InterFacilityConnectionDeliveryCost","description":"InterFacilityConnectionDeliveryCost"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"DeliverCostCoefficient":{"additionalProperties":false,"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"description":"The coefficient value","minimum":0,"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"DeliverCostCoefficient","description":"DeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The PackagingUnitsMoney object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"}}}}
```

## The PackagingUnitSurchargeContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"}}}}
```

## The PackagingUnitSurchargeContextTypes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"}}}}
```

## The PackagingUnitType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"}}}}
```

## The PackingConfigurations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingConfigurations":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"documentHandlingConfiguration":{"$ref":"#/components/schemas/DocumentHandlingConfiguration"},"packingContainerRequiredConfiguration":{"$ref":"#/components/schemas/PackingContainerRequiredConfiguration"},"packingItemConfirmationNeededConfiguration":{"$ref":"#/components/schemas/PackingItemConfirmationNeededConfiguration"},"packingSourceContainerConfiguration":{"$ref":"#/components/schemas/PackingSourceContainerConfiguration"},"scanningConfiguration":{"$ref":"#/components/schemas/PackingScanningConfiguration"}}}],"type":"object","title":"PackingConfigurations","description":"PackingConfigurations"},"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"},"DocumentHandlingConfiguration":{"description":"The configuration allows documents that have been added to the document set of a pack job to be added to the process. The configuration sets the section names of the entities to which external documents will be added to. If the configuration set is empty, no external documents will be added to the process.","properties":{"inheritedDocumentConfigurations":{"items":{"$ref":"#/components/schemas/InheritedDocumentConfiguration"},"type":"array"}},"required":["inheritedDocumentConfigurations"],"title":"DocumentHandlingConfiguration","type":"object"},"InheritedDocumentConfiguration":{"properties":{"section":{"$ref":"#/components/schemas/Section"}},"required":["section"],"title":"InheritedDocumentConfiguration","description":"InheritedDocumentConfiguration"},"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"},"PackingContainerRequiredConfiguration":{"additionalProperties":false,"description":"Packing Container Required Configuration.","properties":{"active":{"default":false,"type":"boolean"}},"required":["active"],"title":"PackingContainerRequiredConfiguration","type":"object"},"PackingItemConfirmationNeededConfiguration":{"additionalProperties":false,"description":"Do the customer need to validate which items are part of a pack job","properties":{"active":{"default":true,"type":"boolean"}},"required":["active"],"title":"PackingItemConfirmationNeededConfiguration","type":"object"},"PackingSourceContainerConfiguration":{"description":"Can this tenant use the packing source container","properties":{"active":{"default":false,"type":"boolean"}},"required":["active"],"title":"PackingSourceContainerConfiguration","type":"object"},"PackingScanningConfiguration":{"description":"Packing Scanning Configuration.","properties":{"scanningType":{"$ref":"#/components/schemas/PackingScanningConfigurationEnum"}},"title":"PackingScanningConfiguration","type":"object"},"PackingScanningConfigurationEnum":{"enum":["MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PackingScanningConfigurationEnum","description":"PackingScanningConfigurationEnum"}}}}
```

## The PackingContainerRequiredConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingContainerRequiredConfiguration":{"additionalProperties":false,"description":"Packing Container Required Configuration.","properties":{"active":{"default":false,"type":"boolean"}},"required":["active"],"title":"PackingContainerRequiredConfiguration","type":"object"}}}}
```

## The PackingContainerType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingContainerType":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"description":"","type":"string"},"id":{"description":"","type":"string"},"name":{"type":"string"},"priority":{"description":"This value gives the priority of the respective packingContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order packingContainerTypes in the UI.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}}}],"required":["id","version","nameLocalized"],"type":"object","title":"PackingContainerType","description":"PackingContainerType"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"}}}}
```

## The PackingContainerTypeForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingContainerTypeForCreation":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"icon":{"$ref":"#/components/schemas/NamedFile"},"priority":{"description":"This value gives the priority in the respective packingContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order packingContainerTypes.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["nameLocalized"],"type":"object","title":"PackingContainerTypeForCreation","description":"PackingContainerTypeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"}}}}
```

## The PackingContainerTypePatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingContainerTypePatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyPackingContainerType"},{"$ref":"#/components/schemas/ModifyPackingContainerTypeIcon"}]},"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":"PackingContainerTypePatchActions"},"title":"PackingContainerTypePatchActions","description":"PackingContainerTypePatchActions"},"ModifyPackingContainerType":{"additionalProperties":false,"description":"Action to a modify the type of a packing container.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyPackingContainerType', because you want to modify a PackingContainerType","enum":["ModifyPackingContainerType"],"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"priority":{"description":"This value gives the priority in the respective packingContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order PackingContainerTypes.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["action"],"title":"ModifyPackingContainerType","type":"object","xml":{"name":"ModifyPackingContainerType"}},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ModifyPackingContainerTypeIcon":{"additionalProperties":false,"description":"Action to a modify the type icon of a packing container.","properties":{"action":{"description":"Use value 'ModifyPackingContainerTypeIcon', because you want to modify a PackingContainerTypes icon","enum":["ModifyPackingContainerTypeIcon"],"type":"string"},"content":{"description":"Content of the icon as base64 string","type":"string"},"name":{"description":"icons filename","type":"string"}},"required":["action","name","content"],"title":"ModifyPackingContainerTypeIcon","type":"object","xml":{"name":"ModifyPackingContainerTypeIcon"}}}}}
```

## The PackingItemConfirmationNeededConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingItemConfirmationNeededConfiguration":{"additionalProperties":false,"description":"Do the customer need to validate which items are part of a pack job","properties":{"active":{"default":true,"type":"boolean"}},"required":["active"],"title":"PackingItemConfirmationNeededConfiguration","type":"object"}}}}
```

## The PackingScanningConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingScanningConfiguration":{"description":"Packing Scanning Configuration.","properties":{"scanningType":{"$ref":"#/components/schemas/PackingScanningConfigurationEnum"}},"title":"PackingScanningConfiguration","type":"object"},"PackingScanningConfigurationEnum":{"enum":["MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PackingScanningConfigurationEnum","description":"PackingScanningConfigurationEnum"}}}}
```

## The PackingScanningConfigurationEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingScanningConfigurationEnum":{"enum":["MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PackingScanningConfigurationEnum","description":"PackingScanningConfigurationEnum"}}}}
```

## The PackingSourceContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingSourceContainer":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the packing source container. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"description":{"description":"Description of the packing source container in the locale the client requests.","type":"string"},"facilityRef":{"description":"Reference to the facility the packing source container is related to.","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingSourceContainerLineItem"},"type":"array"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"name":{"description":"Name of the packing source container in the locale the client requests.","type":"string"},"operativeContainerTypeRef":{"description":"Reference to the assigned operativeContainerType","type":"string"},"packJobRefs":{"description":"List of references to packJobs this packing source container is related to.","items":{"type":"string"},"minItems":1,"type":"array"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"storageLocationRef":{"description":"Reference to the location where the packing source container is located.","type":"string"},"type":{"$ref":"#/components/schemas/PackingSourceContainerType"}}}],"required":["packJobRefs","nameLocalized","facilityRef","id","version","lastModified","created","lineItems","type"],"type":"object","title":"PackingSourceContainer","description":"PackingSourceContainer"},"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"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PackingSourceContainerLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"description":"item that is inside the packingSourceContainer","required":["id","quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItem"},"title":"PackingSourceContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackingSourceContainerType":{"description":"Type of the packing source container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingSourceContainerType"}}}}
```

## The PackingSourceContainerConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingSourceContainerConfiguration":{"description":"Can this tenant use the packing source container","properties":{"active":{"default":false,"type":"boolean"}},"required":["active"],"title":"PackingSourceContainerConfiguration","type":"object"}}}}
```

## The PackingSourceContainerForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingSourceContainerForCreation":{"allOf":[{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"description":"Codes, that identify the article","type":"string"},"minItems":1,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the packing source container. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable.","type":"string"},"icon":{"$ref":"#/components/schemas/NamedFile"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingSourceContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"description":"Reference to the operativeContainerType, available values will be taken from the container type while creating the container","type":"string"},"packJobRefs":{"description":"List of references to packJobs","items":{"type":"string"},"minItems":1,"type":"array"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"storageLocationRef":{"description":"Reference to the location where the packing source container is located.","type":"string"}}}],"required":["packJobRefs","nameLocalized","facilityRef","lineItems"],"type":"object","title":"PackingSourceContainerForCreation","description":"PackingSourceContainerForCreation"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"PackingSourceContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"description":"items that are inside the packingSourceContainer","required":["quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItemForCreation"},"title":"PackingSourceContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The PackingSourceContainerLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingSourceContainerLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"description":"item that is inside the packingSourceContainer","required":["id","quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItem"},"title":"PackingSourceContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PackingSourceContainerLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingSourceContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"description":"items that are inside the packingSourceContainer","required":["quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItemForCreation"},"title":"PackingSourceContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PackingSourceContainerType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingSourceContainerType":{"description":"Type of the packing source container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingSourceContainerType"}}}}
```

## The PackingSourceContainerWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingSourceContainerWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/PackingSourceContainer"}},"required":["payload"],"type":"object","title":"PackingSourceContainerWebHookEvent","description":"PackingSourceContainerWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"PackingSourceContainer":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the packing source container. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"description":{"description":"Description of the packing source container in the locale the client requests.","type":"string"},"facilityRef":{"description":"Reference to the facility the packing source container is related to.","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingSourceContainerLineItem"},"type":"array"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"name":{"description":"Name of the packing source container in the locale the client requests.","type":"string"},"operativeContainerTypeRef":{"description":"Reference to the assigned operativeContainerType","type":"string"},"packJobRefs":{"description":"List of references to packJobs this packing source container is related to.","items":{"type":"string"},"minItems":1,"type":"array"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"storageLocationRef":{"description":"Reference to the location where the packing source container is located.","type":"string"},"type":{"$ref":"#/components/schemas/PackingSourceContainerType"}}}],"required":["packJobRefs","nameLocalized","facilityRef","id","version","lastModified","created","lineItems","type"],"type":"object","title":"PackingSourceContainer","description":"PackingSourceContainer"},"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"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PackingSourceContainerLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"description":"item that is inside the packingSourceContainer","required":["id","quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItem"},"title":"PackingSourceContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackingSourceContainerType":{"description":"Type of the packing source container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingSourceContainerType"}}}}
```

## The PackingTargetContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/PackingTargetContainerForCreation"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Description of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container  (inherited from operative container type).","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"identifierCode":{"description":"The identifier code generated for this container at creation time, used to render its identifier document.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"},"type":"array"},"name":{"description":"Name of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this packing target container is related to.","type":"string"},"packJobRef":{"description":"Reference to the packJob this packing source container is related to.","type":"string"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"shortId":{"description":"Short identifier for the container","type":"string"},"type":{"$ref":"#/components/schemas/PackingTargetContainerType"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}}}],"required":["id","nameLocalized","version","facilityRef","packJobRef","lineItems","type"],"type":"object","title":"PackingTargetContainer","description":"PackingTargetContainer"},"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"},"PackingTargetContainerForCreation":{"allOf":[{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}}}],"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["article","quantity"],"type":"object","title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["id","article","quantity"],"type":"object","title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"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"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs","workflowInformation"],"type":"object"}],"type":"object","title":"Parcel","description":"Parcel"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"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"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object"}],"xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"}}}}
```

## The PackingTargetContainerActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/UpdatePackingTargetContainerLineItemAction"},{"$ref":"#/components/schemas/ReplacePackingTargetContainerLineItemCodesAction"}],"title":"PackingTargetContainerActionsParameter","description":"PackingTargetContainerActionsParameter"},"UpdatePackingTargetContainerLineItemAction":{"additionalProperties":false,"description":"Action to update a packing target container of a line item.","properties":{"name":{"$ref":"#/components/schemas/UpdatePackingTargetContainerLineItemEnum"},"payload":{"additionalProperties":false,"properties":{"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"}},"required":["lineItem"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","payload","name"],"title":"UpdatePackingTargetContainerLineItemAction","type":"object"},"UpdatePackingTargetContainerLineItemEnum":{"enum":["UpdateLineItem"],"type":"string","title":"UpdatePackingTargetContainerLineItemEnum","description":"UpdatePackingTargetContainerLineItemEnum"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["id","article","quantity"],"type":"object","title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"ReplacePackingTargetContainerLineItemCodesAction":{"additionalProperties":false,"description":"Action to replace packing target container codes of a line item.","properties":{"name":{"$ref":"#/components/schemas/ReplacePackingTargetContainerLineItemCodesEnum"},"payload":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"}},"required":["codes"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["payload","version","name"],"title":"ReplacePackingTargetContainerLineItemCodesAction","type":"object"},"ReplacePackingTargetContainerLineItemCodesEnum":{"enum":["ReplaceLineItemCodes"],"type":"string","title":"ReplacePackingTargetContainerLineItemCodesEnum","description":"ReplacePackingTargetContainerLineItemCodesEnum"}}}}
```

## The PackingTargetContainerAttributeItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The PackingTargetContainerForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerForCreation":{"allOf":[{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}}}],"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["article","quantity"],"type":"object","title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PackingTargetContainerLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["id","article","quantity"],"type":"object","title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PackingTargetContainerLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The PackingTargetContainerLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["article","quantity"],"type":"object","title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PackingTargetContainerPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReplaceCodesInPackingTargetContainer"},{"$ref":"#/components/schemas/AddLineItemToPackingTargetContainer"},{"$ref":"#/components/schemas/RemoveLineItemFromPackingTargetContainer"},{"$ref":"#/components/schemas/UpdateLineItemOnPackingTargetContainer"},{"$ref":"#/components/schemas/UpdatePackingTargetContainerLineItemRecordableAttributes"},{"$ref":"#/components/schemas/UpdatePackingTargetContainerStorageLocation"}]},"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":"PackingTargetContainerPatchActions"},"title":"PackingTargetContainerPatchActions","description":"PackingTargetContainerPatchActions"},"ReplaceCodesInPackingTargetContainer":{"additionalProperties":false,"description":"Action to replace codes in packing target container.","properties":{"action":{"description":"Use ReplaceCodesInPackingTargetContainer to add a code to an existing packing container","enum":["ReplaceCodesInPackingTargetContainer"],"type":"string"},"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"}},"required":["action"],"title":"ReplaceCodesInPackingTargetContainer","type":"object","xml":{"name":"ReplaceCodesInPackingTargetContainer"}},"AddLineItemToPackingTargetContainer":{"additionalProperties":false,"description":"Action to a line item to a packing target container.","properties":{"action":{"description":"'Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead'","enum":["AddLineItemToPackingTargetContainer"],"type":"string"},"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"}},"required":["action","lineItem"],"title":"AddLineItemToPackingTargetContainer","type":"object","xml":{"name":"AddLineItemToPackingTargetContainer"}},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["article","quantity"],"type":"object","title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"RemoveLineItemFromPackingTargetContainer":{"additionalProperties":false,"description":"Action to a remove a line item from a packing target container.","properties":{"action":{"description":"'Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead'","enum":["RemoveLineItemFromPackingTargetContainer"],"type":"string"},"lineItemRef":{"description":"Id of the PackLineItem you want to remove.","type":"string"}},"required":["action","lineItemRef"],"title":"RemoveLineItemFromPackingTargetContainer","type":"object","xml":{"name":"RemoveLineItemFromPackingTargetContainer"}},"UpdateLineItemOnPackingTargetContainer":{"additionalProperties":false,"description":"Action to a update a line item of a packing target container.","properties":{"action":{"description":"Use UpdateLineItemOnPackingTargetContainer to change a line item on an existing packing container","enum":["UpdateLineItemOnPackingTargetContainer"],"type":"string"},"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"}},"required":["action","lineItem"],"title":"UpdateLineItemOnPackingTargetContainer","type":"object","xml":{"name":"UpdateLineItemOnPackingTargetContainer"}},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["id","article","quantity"],"type":"object","title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"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"},"UpdatePackingTargetContainerLineItemRecordableAttributes":{"additionalProperties":false,"description":"Action to a update the recordable attributes of the line items of a packing target container.","properties":{"action":{"description":"Use this action to update the recordable attributes of the line items of a packing target container","enum":["UpdatePackingTargetContainerLineItemRecordableAttributes"],"type":"string"},"recordableAttributeUpdates":{"items":{"$ref":"#/components/schemas/RecordableAttributeForUpdate"},"type":"array"}},"required":["action","recordableAttributeUpdates"],"title":"UpdatePackingTargetContainerLineItemRecordableAttributes","type":"object","xml":{"name":"UpdatePackingTargetContainerLineItemRecordableAttributes"}},"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"},"UpdatePackingTargetContainerStorageLocation":{"additionalProperties":false,"description":"Action to update the storageLocationRef of a packing target container.","properties":{"action":{"description":"Use this action to update the storageLocationRef of a packing target container","enum":["UpdatePackingTargetContainerStorageLocation"],"type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"},"version":{"description":"The version of the packing target container to be used in optimistic locking mechanisms.","type":"integer"}},"required":["action","version","storageLocationRef"],"title":"UpdatePackingTargetContainerStorageLocation","type":"object","xml":{"name":"UpdatePackingTargetContainerStorageLocation"}}}}}
```

## The PackingTargetContainerType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"}}}}
```

## The PackingTargetContainerWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackingTargetContainerWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/PackingTargetContainer"}},"required":["payload"],"type":"object","title":"PackingTargetContainerWebHookEvent","description":"PackingTargetContainerWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"PackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/PackingTargetContainerForCreation"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Description of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container  (inherited from operative container type).","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"identifierCode":{"description":"The identifier code generated for this container at creation time, used to render its identifier document.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"},"type":"array"},"name":{"description":"Name of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this packing target container is related to.","type":"string"},"packJobRef":{"description":"Reference to the packJob this packing source container is related to.","type":"string"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"shortId":{"description":"Short identifier for the container","type":"string"},"type":{"$ref":"#/components/schemas/PackingTargetContainerType"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}}}],"required":["id","nameLocalized","version","facilityRef","packJobRef","lineItems","type"],"type":"object","title":"PackingTargetContainer","description":"PackingTargetContainer"},"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"},"PackingTargetContainerForCreation":{"allOf":[{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}}}],"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["article","quantity"],"type":"object","title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["id","article","quantity"],"type":"object","title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"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"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs","workflowInformation"],"type":"object"}],"type":"object","title":"Parcel","description":"Parcel"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"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"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object"}],"xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"}}}}
```

## The PackJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJob":{"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"},"customAttributes":{"description":"Attributes that can be added to the pack job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","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"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"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"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"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"},"maxItems":500,"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"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The PackJobActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/PackJobReplaceAssignedUsersActionParameter"},{"$ref":"#/components/schemas/PackJobSplitLineItemsActionParameter"},{"$ref":"#/components/schemas/UpdatePackLineItemRecordableAttributesActionParameter"},{"$ref":"#/components/schemas/PackJobMoveEachesToSourceContainerActionParameter"},{"$ref":"#/components/schemas/PackJobMoveEachesToTargetContainerActionParameter"},{"$ref":"#/components/schemas/PackJobAddTargetTimeActionParameter"}],"title":"PackJobActionsParameter","description":"PackJobActionsParameter"},"PackJobReplaceAssignedUsersActionParameter":{"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/PackJobReplaceAssignedUsersActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","assignedUsers"],"title":"PackJobReplaceAssignedUsersActionParameter","type":"object"},"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"},"PackJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"PackJobReplaceAssignedUsersActionEnum","description":"PackJobReplaceAssignedUsersActionEnum"},"PackJobSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/PackJobSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/PackJobSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"PackJobSplitLineItemsActionParameter","type":"object","description":"PackJobSplitLineItemsActionParameter"},"PackJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_PACK_JOB"],"type":"string","title":"PackJobSplitLineItemsActionEnum","description":"PackJobSplitLineItemsActionEnum"},"PackJobSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"type":"object","title":"PackJobSplitLineItemsInfo","description":"PackJobSplitLineItemsInfo"},"UpdatePackLineItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdatePackLineItemRecordableAttributesActionEnum"},"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":"UpdatePackLineItemRecordableAttributesActionParameter","type":"object","description":"UpdatePackLineItemRecordableAttributesActionParameter"},"UpdatePackLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_PACK_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdatePackLineItemRecordableAttributesActionEnum","description":"UpdatePackLineItemRecordableAttributesActionEnum"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PackJobMoveEachesToSourceContainerActionParameter":{"additionalProperties":false,"description":"Action to replace the assigned users.","properties":{"move":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerActionParameterMove"},"name":{"$ref":"#/components/schemas/PackJobMoveEachesToSourceContainerActionEnum"}},"required":["name","move"],"title":"PackJobReplaceAssignedUsersActionParameter","type":"object"},"PackJobMoveEachesToContainerActionParameterMove":{"additionalProperties":false,"description":"Assigned users for this entity","properties":{"from":{"items":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerFrom"},"minItems":1,"type":"array"},"to":{"oneOf":[{"$ref":"#/components/schemas/PackJobMoveEachesToContainerTo"},{"$ref":"#/components/schemas/PackJobMoveEachesToNewContainerTo"}]}},"required":["from","to"],"type":"object","title":"PackJobMoveEachesToContainerActionParameterMove"},"PackJobMoveEachesToContainerFrom":{"additionalProperties":false,"description":"Where to take the eaches from","properties":{"containerId":{"description":"id of the container to move the eaches from","type":"string"},"containerVersion":{"description":"version of the container to move the eaches from","minimum":0,"type":"integer"},"globalLineItemId":{"description":"global line item id of the line item to move eaches from","type":"string"},"quantity":{"description":"amount of items to move","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary amount of items to move","minimum":0,"type":"integer"}},"required":["containerId","containerVersion","globalLineItemId","quantity"],"title":"PackJobMoveEachesToContainerFrom","type":"object"},"PackJobMoveEachesToContainerTo":{"additionalProperties":false,"description":"Where to move the eaches to.","properties":{"containerId":{"description":"id of the container to move the eaches to","type":"string"},"containerVersion":{"description":"version of the container to move the eaches to","minimum":0,"type":"integer"}},"required":["containerId","containerVersion"],"title":"PackJobMoveEachesToContainerTo","type":"object"},"PackJobMoveEachesToNewContainerTo":{"additionalProperties":false,"description":"Additional information for the new created container during a move","properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"type":"array"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"}},"required":["operativeContainerTypeRef"],"title":"PackJobMoveEachesToContainerTo","type":"object"},"PackJobMoveEachesToSourceContainerActionEnum":{"enum":["MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER"],"type":"string","title":"PackJobMoveEachesToSourceContainerActionEnum","description":"PackJobMoveEachesToSourceContainerActionEnum"},"PackJobMoveEachesToTargetContainerActionParameter":{"additionalProperties":false,"description":"Action to replace the assigned users.","properties":{"move":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerActionParameterMove"},"name":{"$ref":"#/components/schemas/PackJobMoveEachesToTargetContainerActionEnum"}},"required":["name","move"],"title":"PackJobReplaceAssignedUsersActionParameter","type":"object"},"PackJobMoveEachesToTargetContainerActionEnum":{"enum":["MOVE_EACHES_TO_PACKING_TARGET_CONTAINER"],"type":"string","title":"PackJobMoveEachesToTargetContainerActionEnum","description":"PackJobMoveEachesToTargetContainerActionEnum"},"PackJobAddTargetTimeActionParameter":{"additionalProperties":false,"description":"Action to add targetTime to a PackJob that has none. Will fail if targetTime is already set","properties":{"name":{"$ref":"#/components/schemas/PackJobAddTargetTimeActionEnum"},"targetTime":{"description":"The target time you want set for the given packJob.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"PackJobAddTargetTimeActionParameter"},"PackJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"PackJobAddTargetTimeActionEnum","description":"PackJobAddTargetTimeActionEnum"}}}}
```

## The PackJobAddTargetTimeActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"PackJobAddTargetTimeActionEnum","description":"PackJobAddTargetTimeActionEnum"}}}}
```

## The PackJobAddTargetTimeActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobAddTargetTimeActionParameter":{"additionalProperties":false,"description":"Action to add targetTime to a PackJob that has none. Will fail if targetTime is already set","properties":{"name":{"$ref":"#/components/schemas/PackJobAddTargetTimeActionEnum"},"targetTime":{"description":"The target time you want set for the given packJob.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"PackJobAddTargetTimeActionParameter"},"PackJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"PackJobAddTargetTimeActionEnum","description":"PackJobAddTargetTimeActionEnum"}}}}
```

## The PackJobCreationPerTag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobCreationPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"type":"array"},"packJobCreationDisabled":{"type":"boolean"},"tagRef":{"type":"string"}},"required":["packJobCreationDisabled","matchingValues","tagRef"],"type":"object","title":"PackJobCreationPerTag","description":"PackJobCreationPerTag"}}}}
```

## The PackJobForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobForCreation":{"additionalProperties":false,"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the pack job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"pickJobRef":{"description":"Reference to a pick job","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"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"description":"Tags can only be set when there is no process related with this packJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["facilityRef","lineItems","workflowInformation"],"type":"object","xml":{"name":"PackJobForCreation"},"title":"PackJobForCreation","description":"PackJobForCreation"},"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"},"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"},"maxItems":500,"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"},"PackLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"]}],"type":"object","xml":{"name":"PackLineItemForCreation"},"title":"PackLineItemForCreation","description":"PackLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The PackJobInvoiceFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobInvoiceFilter":{"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":"PackJobInvoiceFilter","type":"object","description":"PackJobInvoiceFilter"},"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"}}}}
```

## The PackJobLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"PackJobLineItemsArticleFilter","type":"object","description":"PackJobLineItemsArticleFilter"},"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"}}}}
```

## The PackJobLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"PackJobLineItemsFilter","type":"object","description":"PackJobLineItemsFilter"},"PackJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"PackJobLineItemsArticleFilter","type":"object","description":"PackJobLineItemsArticleFilter"},"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"}}}}
```

## The PackJobLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PackJobLineItemsListFilter","type":"object","description":"PackJobLineItemsListFilter"},"PackJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"PackJobLineItemsFilter","type":"object","description":"PackJobLineItemsFilter"},"PackJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"PackJobLineItemsArticleFilter","type":"object","description":"PackJobLineItemsArticleFilter"},"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"}}}}
```

## The PackJobMoveEachesToContainerActionParameterMove object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobMoveEachesToContainerActionParameterMove":{"additionalProperties":false,"description":"Assigned users for this entity","properties":{"from":{"items":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerFrom"},"minItems":1,"type":"array"},"to":{"oneOf":[{"$ref":"#/components/schemas/PackJobMoveEachesToContainerTo"},{"$ref":"#/components/schemas/PackJobMoveEachesToNewContainerTo"}]}},"required":["from","to"],"type":"object","title":"PackJobMoveEachesToContainerActionParameterMove"},"PackJobMoveEachesToContainerFrom":{"additionalProperties":false,"description":"Where to take the eaches from","properties":{"containerId":{"description":"id of the container to move the eaches from","type":"string"},"containerVersion":{"description":"version of the container to move the eaches from","minimum":0,"type":"integer"},"globalLineItemId":{"description":"global line item id of the line item to move eaches from","type":"string"},"quantity":{"description":"amount of items to move","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary amount of items to move","minimum":0,"type":"integer"}},"required":["containerId","containerVersion","globalLineItemId","quantity"],"title":"PackJobMoveEachesToContainerFrom","type":"object"},"PackJobMoveEachesToContainerTo":{"additionalProperties":false,"description":"Where to move the eaches to.","properties":{"containerId":{"description":"id of the container to move the eaches to","type":"string"},"containerVersion":{"description":"version of the container to move the eaches to","minimum":0,"type":"integer"}},"required":["containerId","containerVersion"],"title":"PackJobMoveEachesToContainerTo","type":"object"},"PackJobMoveEachesToNewContainerTo":{"additionalProperties":false,"description":"Additional information for the new created container during a move","properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"type":"array"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"}},"required":["operativeContainerTypeRef"],"title":"PackJobMoveEachesToContainerTo","type":"object"}}}}
```

## The PackJobMoveEachesToContainerFrom object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobMoveEachesToContainerFrom":{"additionalProperties":false,"description":"Where to take the eaches from","properties":{"containerId":{"description":"id of the container to move the eaches from","type":"string"},"containerVersion":{"description":"version of the container to move the eaches from","minimum":0,"type":"integer"},"globalLineItemId":{"description":"global line item id of the line item to move eaches from","type":"string"},"quantity":{"description":"amount of items to move","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary amount of items to move","minimum":0,"type":"integer"}},"required":["containerId","containerVersion","globalLineItemId","quantity"],"title":"PackJobMoveEachesToContainerFrom","type":"object"}}}}
```

## The PackJobMoveEachesToContainerTo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobMoveEachesToContainerTo":{"additionalProperties":false,"description":"Where to move the eaches to.","properties":{"containerId":{"description":"id of the container to move the eaches to","type":"string"},"containerVersion":{"description":"version of the container to move the eaches to","minimum":0,"type":"integer"}},"required":["containerId","containerVersion"],"title":"PackJobMoveEachesToContainerTo","type":"object"}}}}
```

## The PackJobMoveEachesToNewContainerTo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobMoveEachesToNewContainerTo":{"additionalProperties":false,"description":"Additional information for the new created container during a move","properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"type":"array"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"}},"required":["operativeContainerTypeRef"],"title":"PackJobMoveEachesToContainerTo","type":"object"}}}}
```

## The PackJobMoveEachesToSourceContainerActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobMoveEachesToSourceContainerActionEnum":{"enum":["MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER"],"type":"string","title":"PackJobMoveEachesToSourceContainerActionEnum","description":"PackJobMoveEachesToSourceContainerActionEnum"}}}}
```

## The PackJobMoveEachesToSourceContainerActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobMoveEachesToSourceContainerActionParameter":{"additionalProperties":false,"description":"Action to replace the assigned users.","properties":{"move":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerActionParameterMove"},"name":{"$ref":"#/components/schemas/PackJobMoveEachesToSourceContainerActionEnum"}},"required":["name","move"],"title":"PackJobReplaceAssignedUsersActionParameter","type":"object"},"PackJobMoveEachesToContainerActionParameterMove":{"additionalProperties":false,"description":"Assigned users for this entity","properties":{"from":{"items":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerFrom"},"minItems":1,"type":"array"},"to":{"oneOf":[{"$ref":"#/components/schemas/PackJobMoveEachesToContainerTo"},{"$ref":"#/components/schemas/PackJobMoveEachesToNewContainerTo"}]}},"required":["from","to"],"type":"object","title":"PackJobMoveEachesToContainerActionParameterMove"},"PackJobMoveEachesToContainerFrom":{"additionalProperties":false,"description":"Where to take the eaches from","properties":{"containerId":{"description":"id of the container to move the eaches from","type":"string"},"containerVersion":{"description":"version of the container to move the eaches from","minimum":0,"type":"integer"},"globalLineItemId":{"description":"global line item id of the line item to move eaches from","type":"string"},"quantity":{"description":"amount of items to move","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary amount of items to move","minimum":0,"type":"integer"}},"required":["containerId","containerVersion","globalLineItemId","quantity"],"title":"PackJobMoveEachesToContainerFrom","type":"object"},"PackJobMoveEachesToContainerTo":{"additionalProperties":false,"description":"Where to move the eaches to.","properties":{"containerId":{"description":"id of the container to move the eaches to","type":"string"},"containerVersion":{"description":"version of the container to move the eaches to","minimum":0,"type":"integer"}},"required":["containerId","containerVersion"],"title":"PackJobMoveEachesToContainerTo","type":"object"},"PackJobMoveEachesToNewContainerTo":{"additionalProperties":false,"description":"Additional information for the new created container during a move","properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"type":"array"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"}},"required":["operativeContainerTypeRef"],"title":"PackJobMoveEachesToContainerTo","type":"object"},"PackJobMoveEachesToSourceContainerActionEnum":{"enum":["MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER"],"type":"string","title":"PackJobMoveEachesToSourceContainerActionEnum","description":"PackJobMoveEachesToSourceContainerActionEnum"}}}}
```

## The PackJobMoveEachesToTargetContainerActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobMoveEachesToTargetContainerActionEnum":{"enum":["MOVE_EACHES_TO_PACKING_TARGET_CONTAINER"],"type":"string","title":"PackJobMoveEachesToTargetContainerActionEnum","description":"PackJobMoveEachesToTargetContainerActionEnum"}}}}
```

## The PackJobMoveEachesToTargetContainerActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobMoveEachesToTargetContainerActionParameter":{"additionalProperties":false,"description":"Action to replace the assigned users.","properties":{"move":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerActionParameterMove"},"name":{"$ref":"#/components/schemas/PackJobMoveEachesToTargetContainerActionEnum"}},"required":["name","move"],"title":"PackJobReplaceAssignedUsersActionParameter","type":"object"},"PackJobMoveEachesToContainerActionParameterMove":{"additionalProperties":false,"description":"Assigned users for this entity","properties":{"from":{"items":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerFrom"},"minItems":1,"type":"array"},"to":{"oneOf":[{"$ref":"#/components/schemas/PackJobMoveEachesToContainerTo"},{"$ref":"#/components/schemas/PackJobMoveEachesToNewContainerTo"}]}},"required":["from","to"],"type":"object","title":"PackJobMoveEachesToContainerActionParameterMove"},"PackJobMoveEachesToContainerFrom":{"additionalProperties":false,"description":"Where to take the eaches from","properties":{"containerId":{"description":"id of the container to move the eaches from","type":"string"},"containerVersion":{"description":"version of the container to move the eaches from","minimum":0,"type":"integer"},"globalLineItemId":{"description":"global line item id of the line item to move eaches from","type":"string"},"quantity":{"description":"amount of items to move","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary amount of items to move","minimum":0,"type":"integer"}},"required":["containerId","containerVersion","globalLineItemId","quantity"],"title":"PackJobMoveEachesToContainerFrom","type":"object"},"PackJobMoveEachesToContainerTo":{"additionalProperties":false,"description":"Where to move the eaches to.","properties":{"containerId":{"description":"id of the container to move the eaches to","type":"string"},"containerVersion":{"description":"version of the container to move the eaches to","minimum":0,"type":"integer"}},"required":["containerId","containerVersion"],"title":"PackJobMoveEachesToContainerTo","type":"object"},"PackJobMoveEachesToNewContainerTo":{"additionalProperties":false,"description":"Additional information for the new created container during a move","properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"type":"array"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"}},"required":["operativeContainerTypeRef"],"title":"PackJobMoveEachesToContainerTo","type":"object"},"PackJobMoveEachesToTargetContainerActionEnum":{"enum":["MOVE_EACHES_TO_PACKING_TARGET_CONTAINER"],"type":"string","title":"PackJobMoveEachesToTargetContainerActionEnum","description":"PackJobMoveEachesToTargetContainerActionEnum"}}}}
```

## The PackJobOrderBy object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobOrderBy":{"description":"Attribute to order a packJobs by","enum":["TARGET_TIME_DESC","TARGET_TIME_ASC","LAST_MODIFIED_DESC","LAST_MODIFIED_ASC","ORDER_DATE_DESC","ORDER_DATE_ASC"],"type":"string","xml":{"name":"PackJobOrderBy"},"title":"PackJobOrderBy"}}}}
```

## The PackJobPackingSourceContainersFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobPackingSourceContainersFilter":{"properties":{"codes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by codes"}},"title":"PackJobPackingSourceContainersFilter","type":"object","description":"PackJobPackingSourceContainersFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The PackJobPackingSourceContainersListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobPackingSourceContainersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PackJobPackingSourceContainersListFilter","type":"object","description":"PackJobPackingSourceContainersListFilter"},"PackJobPackingSourceContainersFilter":{"properties":{"codes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by codes"}},"title":"PackJobPackingSourceContainersFilter","type":"object","description":"PackJobPackingSourceContainersFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The PackJobPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobPaginatedResult":{"properties":{"packJobs":{"items":{"$ref":"#/components/schemas/PackJob"},"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","packJobs"],"title":"PackJobPaginatedResult","type":"object","description":"PackJobPaginatedResult"},"PackJob":{"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"},"customAttributes":{"description":"Attributes that can be added to the pack job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","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"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"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"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"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"},"maxItems":500,"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"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"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"}}}}
```

## The PackJobPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyPackJob"},{"$ref":"#/components/schemas/ModifyPackLineItem"},{"$ref":"#/components/schemas/PausePackJob"}]},"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":"PackJobPatchActions"},"title":"PackJobPatchActions","description":"PackJobPatchActions"},"ModifyPackJob":{"additionalProperties":false,"description":"Action to modify a PackJob","properties":{"action":{"description":"Use value 'ModifyPackJob', because you want to modify a packjob","enum":["ModifyPackJob"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the line item. 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/PackJobStatus"}},"required":["action"],"title":"ModifyPackJob","type":"object","xml":{"name":"ModifyPackJob"}},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"ModifyPackLineItem":{"additionalProperties":false,"description":"Action to modify a PackLineItem of a PackJob","properties":{"action":{"description":"Use value 'ModifyPackLineItem', because you want to modify a packjobs lineItem","enum":["ModifyPackLineItem"],"type":"string"},"id":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this packline. Can't be more than picked before.","format":"int64","minimum":0,"type":"integer"}},"required":["action","id"],"title":"ModifyPackLineItem","type":"object","xml":{"name":"ModifyPackLineItem"}},"PausePackJob":{"additionalProperties":false,"description":"Action to pause a PackJob","properties":{"action":{"description":"Use value 'PausePackJob', because you want to pause a packjob","enum":["PausePackJob"],"type":"string"},"packLineItemsUpdate":{"items":{"$ref":"#/components/schemas/PackLineItemForUpdate"},"type":"array"}},"required":["action"],"title":"PausePackJob","type":"object","xml":{"name":"PausePackJob"}},"PackLineItemForUpdate":{"properties":{"id":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this packline. Can't be more than picked before.","format":"int64","minimum":0,"type":"integer"}},"required":["id","packed"],"type":"object","xml":{"name":"PackLineItemForUpdate"},"title":"PackLineItemForUpdate","description":"PackLineItemForUpdate"}}}}
```

## The PackJobRecipientFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobRecipientFilter":{"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":"PackJobRecipientFilter","type":"object","description":"PackJobRecipientFilter"},"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"}}}}
```

## The PackJobReplaceAssignedUsersActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"PackJobReplaceAssignedUsersActionEnum","description":"PackJobReplaceAssignedUsersActionEnum"}}}}
```

## The PackJobReplaceAssignedUsersActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobReplaceAssignedUsersActionParameter":{"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/PackJobReplaceAssignedUsersActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","assignedUsers"],"title":"PackJobReplaceAssignedUsersActionParameter","type":"object"},"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"},"PackJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"PackJobReplaceAssignedUsersActionEnum","description":"PackJobReplaceAssignedUsersActionEnum"}}}}
```

## The PackJobs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobs":{"properties":{"packJobs":{"items":{"$ref":"#/components/schemas/PackJobWithSearchPath"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"PackJobs","description":"PackJobs"},"PackJobWithSearchPath":{"allOf":[{"$ref":"#/components/schemas/PackJob"},{"additionalProperties":false,"properties":{"searchPaths":{"items":{"type":"string"},"minItems":0,"type":"array"}}}],"xml":{"name":"PackJobWithPath"},"title":"PackJobWithSearchPath","description":"PackJobWithSearchPath"},"PackJob":{"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"},"customAttributes":{"description":"Attributes that can be added to the pack job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","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"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"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"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"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"},"maxItems":500,"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"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The PackJobSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobSearchPayload":{"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/PackJobSearchQuery"},"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/PackJobSort"},"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":"PackJobSearchPayload","type":"object","description":"PackJobSearchPayload"},"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"},"PackJobSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/PackJobSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoice":{"allOf":[{"$ref":"#/components/schemas/PackJobInvoiceFilter"}],"description":"Nested search by invoice"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"lineItems":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsListFilter"}],"description":"Nested list search by lineItems"},"or":{"items":{"$ref":"#/components/schemas/PackJobSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"packingSourceContainers":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersListFilter"}],"description":"Nested list search by packingSourceContainers"},"recipient":{"allOf":[{"$ref":"#/components/schemas/PackJobRecipientFilter"}],"description":"Nested search by recipient"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/PackJobStatusEnumFilter"}],"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":"PackJobSearchQuery","type":"object","description":"PackJobSearchQuery"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"PackJobInvoiceFilter":{"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":"PackJobInvoiceFilter","type":"object","description":"PackJobInvoiceFilter"},"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"},"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"},"PackJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PackJobLineItemsListFilter","type":"object","description":"PackJobLineItemsListFilter"},"PackJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"PackJobLineItemsFilter","type":"object","description":"PackJobLineItemsFilter"},"PackJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"PackJobLineItemsArticleFilter","type":"object","description":"PackJobLineItemsArticleFilter"},"PackJobPackingSourceContainersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PackJobPackingSourceContainersListFilter","type":"object","description":"PackJobPackingSourceContainersListFilter"},"PackJobPackingSourceContainersFilter":{"properties":{"codes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by codes"}},"title":"PackJobPackingSourceContainersFilter","type":"object","description":"PackJobPackingSourceContainersFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"PackJobRecipientFilter":{"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":"PackJobRecipientFilter","type":"object","description":"PackJobRecipientFilter"},"PackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"PackJobStatusEnumFilter","type":"object","description":"PackJobStatusEnumFilter"},"PackJobSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"PackJobSort","type":"object","description":"PackJobSort"}}}}
```

## The PackJobSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/PackJobSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoice":{"allOf":[{"$ref":"#/components/schemas/PackJobInvoiceFilter"}],"description":"Nested search by invoice"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"lineItems":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsListFilter"}],"description":"Nested list search by lineItems"},"or":{"items":{"$ref":"#/components/schemas/PackJobSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"packingSourceContainers":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersListFilter"}],"description":"Nested list search by packingSourceContainers"},"recipient":{"allOf":[{"$ref":"#/components/schemas/PackJobRecipientFilter"}],"description":"Nested search by recipient"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/PackJobStatusEnumFilter"}],"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":"PackJobSearchQuery","type":"object","description":"PackJobSearchQuery"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"PackJobInvoiceFilter":{"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":"PackJobInvoiceFilter","type":"object","description":"PackJobInvoiceFilter"},"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"},"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"},"PackJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PackJobLineItemsListFilter","type":"object","description":"PackJobLineItemsListFilter"},"PackJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"PackJobLineItemsFilter","type":"object","description":"PackJobLineItemsFilter"},"PackJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"PackJobLineItemsArticleFilter","type":"object","description":"PackJobLineItemsArticleFilter"},"PackJobPackingSourceContainersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PackJobPackingSourceContainersListFilter","type":"object","description":"PackJobPackingSourceContainersListFilter"},"PackJobPackingSourceContainersFilter":{"properties":{"codes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by codes"}},"title":"PackJobPackingSourceContainersFilter","type":"object","description":"PackJobPackingSourceContainersFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"PackJobRecipientFilter":{"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":"PackJobRecipientFilter","type":"object","description":"PackJobRecipientFilter"},"PackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"PackJobStatusEnumFilter","type":"object","description":"PackJobStatusEnumFilter"}}}}
```

## The PackJobSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"PackJobSort","type":"object","description":"PackJobSort"}}}}
```

## The PackJobSplitLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_PACK_JOB"],"type":"string","title":"PackJobSplitLineItemsActionEnum","description":"PackJobSplitLineItemsActionEnum"}}}}
```

## The PackJobSplitLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/PackJobSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/PackJobSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"PackJobSplitLineItemsActionParameter","type":"object","description":"PackJobSplitLineItemsActionParameter"},"PackJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_PACK_JOB"],"type":"string","title":"PackJobSplitLineItemsActionEnum","description":"PackJobSplitLineItemsActionEnum"},"PackJobSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"type":"object","title":"PackJobSplitLineItemsInfo","description":"PackJobSplitLineItemsInfo"}}}}
```

## The PackJobSplitLineItemsInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"type":"object","title":"PackJobSplitLineItemsInfo","description":"PackJobSplitLineItemsInfo"}}}}
```

## The PackJobStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"}}}}
```

## The PackJobStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"PackJobStatusEnumFilter","type":"object","description":"PackJobStatusEnumFilter"}}}}
```

## The PackJobTagConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/TagConfiguration"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"lineItemStickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"},"packJobCreationPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/PackJobCreationPerTag"},"type":"array"},"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}}}],"required":["packJobCreationPerTag","version"],"type":"object","title":"PackJobTagConfiguration","description":"PackJobTagConfiguration"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"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"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PackJobCreationPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"type":"array"},"packJobCreationDisabled":{"type":"boolean"},"tagRef":{"type":"string"}},"required":["packJobCreationDisabled","matchingValues","tagRef"],"type":"object","title":"PackJobCreationPerTag","description":"PackJobCreationPerTag"}}}}
```

## The PackJobWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/PackJob"}},"required":["payload"],"type":"object","title":"PackJobWebHookEvent","description":"PackJobWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"PackJob":{"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"},"customAttributes":{"description":"Attributes that can be added to the pack job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","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"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"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"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"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"},"maxItems":500,"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"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The PackJobWithSearchPath object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackJobWithSearchPath":{"allOf":[{"$ref":"#/components/schemas/PackJob"},{"additionalProperties":false,"properties":{"searchPaths":{"items":{"type":"string"},"minItems":0,"type":"array"}}}],"xml":{"name":"PackJobWithPath"},"title":"PackJobWithSearchPath","description":"PackJobWithSearchPath"},"PackJob":{"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"},"customAttributes":{"description":"Attributes that can be added to the pack job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","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"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"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"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"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"},"maxItems":500,"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"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The PackLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PackLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The PackLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"]}],"type":"object","xml":{"name":"PackLineItemForCreation"},"title":"PackLineItemForCreation","description":"PackLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"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. Ensure that no authentication is needed 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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PackLineItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PackLineItemForUpdate":{"properties":{"id":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this packline. Can't be more than picked before.","format":"int64","minimum":0,"type":"integer"}},"required":["id","packed"],"type":"object","xml":{"name":"PackLineItemForUpdate"},"title":"PackLineItemForUpdate","description":"PackLineItemForUpdate"}}}}
```

## The PageInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The PaginatedPackingSourceContainers object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PaginatedPackingSourceContainers":{"properties":{"packingSourceContainers":{"items":{"$ref":"#/components/schemas/PackingSourceContainer"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"PaginatedPackingSourceContainers","description":"PaginatedPackingSourceContainers"},"PackingSourceContainer":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the packing source container. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"description":{"description":"Description of the packing source container in the locale the client requests.","type":"string"},"facilityRef":{"description":"Reference to the facility the packing source container is related to.","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingSourceContainerLineItem"},"type":"array"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"name":{"description":"Name of the packing source container in the locale the client requests.","type":"string"},"operativeContainerTypeRef":{"description":"Reference to the assigned operativeContainerType","type":"string"},"packJobRefs":{"description":"List of references to packJobs this packing source container is related to.","items":{"type":"string"},"minItems":1,"type":"array"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"storageLocationRef":{"description":"Reference to the location where the packing source container is located.","type":"string"},"type":{"$ref":"#/components/schemas/PackingSourceContainerType"}}}],"required":["packJobRefs","nameLocalized","facilityRef","id","version","lastModified","created","lineItems","type"],"type":"object","title":"PackingSourceContainer","description":"PackingSourceContainer"},"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"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PackingSourceContainerLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"description":"item that is inside the packingSourceContainer","required":["id","quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItem"},"title":"PackingSourceContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackingSourceContainerType":{"description":"Type of the packing source container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingSourceContainerType"}}}}
```

## The PalletDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PalletDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"loadCarrierHeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The height in millimeters of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"loadCarrierWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The tare weight in grams of the empty load carrier (e.g. pallet or skid) itself.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolumetricWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The maximum volumetric weight the packagingUnit can hold, as a feasibility cap.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","dimensions","maxWeight","volumetricWeightFactor","packagingPricingDetails"],"title":"PalletDetails","type":"object","description":"PalletDetails"},"PackagingUnitDetailDimensions":{"properties":{"maxHeight":{"description":"The max height of the packagingUnit in millimeters.","type":"number"},"maxLength":{"description":"The max length of the packagingUnit in millimeters.","type":"number"},"maxWidth":{"description":"The max width of the packagingUnit in millimeters.","type":"number"}},"required":["maxHeight","maxLength","maxWidth"],"title":"PackagingUnitDetailDimensions","type":"object","description":"PackagingUnitDetailDimensions"},"PackagingPricingDetails":{"properties":{"costCoefficient":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitCostCoefficient"}],"description":"Cost coefficient for two-man handling"},"pricing":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricingByZone"},"maxItems":500,"type":"array"},"surchargesPerPackagingUnits":{"description":"The surcharge applied per packagingUnit.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackagingUnitDetailRelativeSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"}]},"maxItems":500,"type":"array"}},"required":["pricing"],"title":"PackagingPricingDetails","type":"object","description":"PackagingPricingDetails"},"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"},"PackagingUnitPricingBasis":{"properties":{"pricingQuantities":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","items":{"$ref":"#/components/schemas/PackagingUnitPricingQuantity"},"maxItems":3,"type":"array"},"pricingUnit":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingUnit"}],"description":"The unit the pricing quantities are converted to and priced in."}},"required":["pricingUnit","pricingQuantities"],"title":"PackagingUnitPricingBasis","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />PackagingUnitPricingBasis"},"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"},"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"}}}}
```

## The Parcel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs","workflowInformation"],"type":"object"}],"type":"object","title":"Parcel","description":"Parcel"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"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"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object"}],"xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The ParcelActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/ParcelSplitItemsActionParameter"},{"$ref":"#/components/schemas/ParcelUpdateTrackingDataActionParameter"},{"$ref":"#/components/schemas/UpdateParcelItemRecordableAttributesActionParameter"},{"$ref":"#/components/schemas/AddLabelsToParcelActionParameter"}],"title":"ParcelActionsParameter","description":"ParcelActionsParameter"},"ParcelSplitItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ParcelSplitItemsActionEnum"},"splitItemsInfo":{"items":{"$ref":"#/components/schemas/ParcelSplitItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitItemsInfo"],"title":"ParcelSplitItemsActionParameter","type":"object","description":"ParcelSplitItemsActionParameter"},"ParcelSplitItemsActionEnum":{"enum":["SPLIT_LINES_PARCEL"],"type":"string","title":"ParcelSplitItemsActionEnum","description":"ParcelSplitItemsActionEnum"},"ParcelSplitItemsInfo":{"additionalProperties":false,"properties":{"itemId":{"description":"references the id of the item of a parcel","type":"string"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["itemId","quantity"],"type":"object","title":"ParcelSplitItemsInfo","description":"ParcelSplitItemsInfo"},"ParcelUpdateTrackingDataActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ParcelUpdateTrackingDataActionEnum"},"trackingData":{"items":{"anyOf":[{"$ref":"#/components/schemas/ParcelTrackingData"}]},"maxItems":2,"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","trackingData"],"title":"ParcelUpdateTrackingDataActionParameter","type":"object","description":"ParcelUpdateTrackingDataActionParameter"},"ParcelUpdateTrackingDataActionEnum":{"enum":["UPDATE_TRACKING_DATA"],"type":"string","title":"ParcelUpdateTrackingDataActionEnum","description":"ParcelUpdateTrackingDataActionEnum"},"ParcelTrackingData":{"additionalProperties":false,"properties":{"carrierStatus":{"description":"Optional additional carrier tracker information","type":"string"},"status":{"$ref":"#/components/schemas/ParcelTrackingDataStatusEnum"},"trackingNumber":{"description":"123456789","type":"string"},"type":{"$ref":"#/components/schemas/ParcelTrackingDataType"}},"required":["type","status","trackingNumber"],"title":"ParcelTrackingData","type":"object","description":"ParcelTrackingData"},"ParcelTrackingDataStatusEnum":{"description":"Status of the given enum to be mapped onto the found parcel","enum":["DELIVERED","PICKED_UP"],"type":"string","title":"ParcelTrackingDataStatusEnum"},"ParcelTrackingDataType":{"description":"Which kind of tracking data you want to add to the parcel label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelTrackingDataType"},"UpdateParcelItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdateParcelItemRecordableAttributesActionEnum"},"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":"UpdateParcelItemRecordableAttributesActionParameter","type":"object","description":"UpdateParcelItemRecordableAttributesActionParameter"},"UpdateParcelItemRecordableAttributesActionEnum":{"enum":["UPDATE_PARCEL_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdateParcelItemRecordableAttributesActionEnum","description":"UpdateParcelItemRecordableAttributesActionEnum"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AddLabelsToParcelActionParameter":{"additionalProperties":false,"properties":{"closeParcel":{"default":false,"description":"Close the parcel after adding this labels. Further adding will not be possible.","type":"boolean"},"customsDocument":{"$ref":"#/components/schemas/AddCustomsDocumentToParcelContent"},"labels":{"items":{"anyOf":[{"$ref":"#/components/schemas/AddLabelsToParcelContent"},{"$ref":"#/components/schemas/AddLabelsToParcelError"}]},"maxItems":2,"minItems":0,"type":"array"},"name":{"$ref":"#/components/schemas/AddLabelsToParcelActionEnum"},"tenantParcelId":{"description":"Optional parameter to set or change the tenant parcel id","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","labels"],"title":"AddLabelsToParcelActionParameter","type":"object","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />AddLabelsToParcelActionParameter"},"AddCustomsDocumentToParcelContent":{"additionalProperties":false,"description":"File and Document for this Label","properties":{"labelFile":{"$ref":"#/components/schemas/AddLabelsToParcelFile"}},"required":["labelFile"],"type":"object","title":"AddCustomsDocumentToParcelContent"},"AddLabelsToParcelFile":{"additionalProperties":false,"description":"file for a given result","properties":{"content":{"description":"File content base64 encoded","type":"string"},"fileName":{"description":"Name of the File that will be created. If not passed the name will be automatically assigned to <labelType>.<type>. Allowed values if passed are: <a-zA-Z0-9_->+<.pdf|.zpl>","maxLength":50,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["content","type"],"type":"object","title":"AddLabelsToParcelFile"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"},"AddLabelsToParcelContent":{"additionalProperties":false,"description":"File and Document for this Label","properties":{"labelFile":{"$ref":"#/components/schemas/AddLabelsToParcelFile"},"labelType":{"$ref":"#/components/schemas/ParcelLabelType"},"trackingNumber":{"description":"The reference number by the carrier","type":"string"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["labelType","labelFile","trackingNumber","trackingUrl"],"type":"object","title":"AddLabelsToParcelContent"},"ParcelLabelType":{"description":"Which kind of label you want to add to the parcel","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelLabelType"},"AddLabelsToParcelError":{"additionalProperties":false,"description":"Error values for a not successfull label request","properties":{"errorCode":{"description":"optional error code from the carrier","type":"string"},"errorDescription":{"description":"raw text error message","type":"string"},"labelType":{"$ref":"#/components/schemas/ParcelLabelType"}},"required":["labelType","errorDescription"],"type":"object","title":"AddLabelsToParcelError"},"AddLabelsToParcelActionEnum":{"enum":["ADD_LABELS_TO_PARCEL"],"type":"string","title":"AddLabelsToParcelActionEnum","description":"AddLabelsToParcelActionEnum"}}}}
```

## The ParcelArticleAttributeItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelArticleAttributeItemForUpdate":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"required":["key","value","category"],"title":"ParcelArticleAttributeItemForUpdate","description":"ParcelArticleAttributeItemForUpdate"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The ParcelCarrierInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"}}}}
```

## The ParcelDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolumetricWeight":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The maximum volumetric weight the packagingUnit can hold, as a feasibility cap.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"}},"required":["type","dimensions","maxWeight","packagingPricingDetails"],"title":"ParcelDetails","type":"object","description":"ParcelDetails"},"PackagingUnitDetailDimensions":{"properties":{"maxHeight":{"description":"The max height of the packagingUnit in millimeters.","type":"number"},"maxLength":{"description":"The max length of the packagingUnit in millimeters.","type":"number"},"maxWidth":{"description":"The max width of the packagingUnit in millimeters.","type":"number"}},"required":["maxHeight","maxLength","maxWidth"],"title":"PackagingUnitDetailDimensions","type":"object","description":"PackagingUnitDetailDimensions"},"PackagingPricingDetails":{"properties":{"costCoefficient":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitCostCoefficient"}],"description":"Cost coefficient for two-man handling"},"pricing":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricingByZone"},"maxItems":500,"type":"array"},"surchargesPerPackagingUnits":{"description":"The surcharge applied per packagingUnit.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackagingUnitDetailRelativeSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"}]},"maxItems":500,"type":"array"}},"required":["pricing"],"title":"PackagingPricingDetails","type":"object","description":"PackagingPricingDetails"},"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"},"PackagingUnitPricingBasis":{"properties":{"pricingQuantities":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","items":{"$ref":"#/components/schemas/PackagingUnitPricingQuantity"},"maxItems":3,"type":"array"},"pricingUnit":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingUnit"}],"description":"The unit the pricing quantities are converted to and priced in."}},"required":["pricingUnit","pricingQuantities"],"title":"PackagingUnitPricingBasis","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />PackagingUnitPricingBasis"},"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"},"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"}}}}
```

## The ParcelDimensions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"}}}}
```

## The ParcelForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelForCreation":{"additionalProperties":false,"properties":{"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"references the carrier to be used for sending. Can not be set when creating a parcel for an existing shipment.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItemForCreation"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"parentRef":{"description":"Reference to the parent container of this parcel","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This value is calculated from the items in the parcel.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"type":"object","title":"ParcelForCreation","description":"ParcelForCreation"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItemForCreation":{"allOf":[{"$ref":"#/components/schemas/LineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"description":"Description of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Weight of a single item in gram. Deprecated - Use article.attribute.weightPerUnit instead","type":"integer"}},"required":["quantity"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelItemForCreation","description":"ParcelItemForCreation"},"LineItemForCreation":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"title":"LineItemForCreation","type":"object","description":"LineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"}}}}
```

## The ParcelForDirectCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelForDirectCreation":{"additionalProperties":false,"properties":{"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"references the carrier to be used for sending. Can not be set when creating a parcel for an existing shipment.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"facilityRef":{"description":"Reference to the facility this parcel is created for","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItemForCreation"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"description":"Reference to the operative process this parcel is created for","type":"string"},"orderDate":{"description":"Date when the order for the given parcel has been placed Mandatory when no shipmentRef was provided","format":"date-time","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"processRef":{"description":"Reference to the process this parcel is created for","type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This value is calculated from the items in the parcel.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"Reference to the shipment this parcel is created for. If non provided, a shipment will be created automatically.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"targetTime":{"description":"The target time for the parcel to be delivered. If not provided, the current time will be used.","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"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"}},"required":["facilityRef","carrierRef","recipient","sender"],"type":"object","title":"ParcelForDirectCreation","description":"ParcelForDirectCreation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItemForCreation":{"allOf":[{"$ref":"#/components/schemas/LineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"description":"Description of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Weight of a single item in gram. Deprecated - Use article.attribute.weightPerUnit instead","type":"integer"}},"required":["quantity"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelItemForCreation","description":"ParcelItemForCreation"},"LineItemForCreation":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"title":"LineItemForCreation","type":"object","description":"LineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"}}}}
```

## The ParcelInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"created":{"description":"Creation date of this parcelInformation","format":"date-time","type":"string"},"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"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationDimensions"}],"description":"Dimension information of this parcel information"},"facilityRef":{"description":"Reference to related facility","type":"string"},"id":{"description":"Unique identifier of this parcelInformation","type":"string"},"lastModified":{"description":"Last modification date of this parcelInformation","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process.","type":"string"},"parcelInformationLineItems":{"description":"Items that are contained in this parcel information","items":{"$ref":"#/components/schemas/ParcelInformationLineItem"},"maxItems":50,"minItems":0,"type":"array"},"processRef":{"description":"Reference to related process.","type":"string"},"shippingInformationRef":{"description":"Reference to related shipping information.","type":"string"},"shortId":{"description":"A short identifier that helps assigning a parcelInformation to a customer","type":"string"},"version":{"description":"Version number of this parcelInformation","type":"integer"},"weights":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeights"}],"description":"Weight information of this parcel information"}},"required":["id","version","created","lastModified","processRef","operativeProcessRef","facilityRef","shippingInformationRef","parcelInformationLineItems"],"title":"ParcelInformation","type":"object","description":"ParcelInformation"},"ParcelInformationDimensions":{"properties":{"decimalPlaces":{"description":"The number of decimal places the dimensions have. Max value is 2","maximum":2,"minimum":0,"type":"integer"},"height":{"description":"The height of the parcel without decimal places","minimum":1,"type":"integer"},"length":{"description":"The length of the parcel without decimal places","minimum":1,"type":"integer"},"unit":{"description":"The unit of the dimensions. For now only CENTIMETER is supported","enum":["CENTIMETER"],"type":"string"},"width":{"description":"The width of the parcel without decimal places","minimum":1,"type":"integer"}},"required":["height","width","length","unit","decimalPlaces"],"title":"ParcelInformationDimensions","type":"object","description":"ParcelInformationDimensions"},"ParcelInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this parcelInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ParcelInformationLineItem","type":"object","description":"ParcelInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ParcelInformationWeights":{"properties":{"autoCalculated":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight automatically calculated from the line items of this parcel information. The weights per item are taken from article.attributes (category: dimensions, key: weightPerUnit, type: NUMBER). Only if ALL items have this attribute a weight will be calculated. If at least one item does not have this attribute, autoCalculated will not be set."},"manuallySet":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight manually set for this parcel information"}},"title":"ParcelInformationWeights","type":"object","description":"ParcelInformationWeights"},"ParcelInformationWeight":{"properties":{"decimalPlaces":{"description":"The number of decimal places the weight has. Max value is 3","maximum":3,"minimum":0,"type":"integer"},"unit":{"description":"The unit of the weight. For now only GRAM is supported","enum":["GRAM"],"type":"string"},"weight":{"description":"The weight of the parcel without decimal places.","minimum":1,"type":"integer"}},"required":["unit","decimalPlaces","weight"],"title":"ParcelInformationWeight","type":"object","description":"ParcelInformationWeight"}}}}
```

## The ParcelInformationDimensions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationDimensions":{"properties":{"decimalPlaces":{"description":"The number of decimal places the dimensions have. Max value is 2","maximum":2,"minimum":0,"type":"integer"},"height":{"description":"The height of the parcel without decimal places","minimum":1,"type":"integer"},"length":{"description":"The length of the parcel without decimal places","minimum":1,"type":"integer"},"unit":{"description":"The unit of the dimensions. For now only CENTIMETER is supported","enum":["CENTIMETER"],"type":"string"},"width":{"description":"The width of the parcel without decimal places","minimum":1,"type":"integer"}},"required":["height","width","length","unit","decimalPlaces"],"title":"ParcelInformationDimensions","type":"object","description":"ParcelInformationDimensions"}}}}
```

## The ParcelInformationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationForCreation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"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"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationDimensions"}],"description":"Dimension information of this parcel information"},"parcelInformationLineItems":{"description":"Items that are contained in this parcel information","items":{"$ref":"#/components/schemas/ParcelInformationLineItemForCreation"},"maxItems":50,"minItems":0,"type":"array"},"shippingInformationRef":{"description":"Reference to related shipping information.","type":"string"},"shortId":{"description":"A short identifier that helps assigning a parcelInformation to a customer","type":"string"},"weights":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeightsForCreation"}],"description":"Weight information of this parcel information"}},"required":["shippingInformationRef","parcelInformationLineItems"],"title":"ParcelInformationForCreation","type":"object","description":"ParcelInformationForCreation"},"ParcelInformationDimensions":{"properties":{"decimalPlaces":{"description":"The number of decimal places the dimensions have. Max value is 2","maximum":2,"minimum":0,"type":"integer"},"height":{"description":"The height of the parcel without decimal places","minimum":1,"type":"integer"},"length":{"description":"The length of the parcel without decimal places","minimum":1,"type":"integer"},"unit":{"description":"The unit of the dimensions. For now only CENTIMETER is supported","enum":["CENTIMETER"],"type":"string"},"width":{"description":"The width of the parcel without decimal places","minimum":1,"type":"integer"}},"required":["height","width","length","unit","decimalPlaces"],"title":"ParcelInformationDimensions","type":"object","description":"ParcelInformationDimensions"},"ParcelInformationLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"ParcelInformationLineItemForCreation","type":"object","description":"ParcelInformationLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ParcelInformationWeightsForCreation":{"properties":{"manuallySet":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight manually set for this parcel information"}},"required":["manuallySet"],"title":"ParcelInformationWeightsForCreation","type":"object","description":"ParcelInformationWeightsForCreation"},"ParcelInformationWeight":{"properties":{"decimalPlaces":{"description":"The number of decimal places the weight has. Max value is 3","maximum":3,"minimum":0,"type":"integer"},"unit":{"description":"The unit of the weight. For now only GRAM is supported","enum":["GRAM"],"type":"string"},"weight":{"description":"The weight of the parcel without decimal places.","minimum":1,"type":"integer"}},"required":["unit","decimalPlaces","weight"],"title":"ParcelInformationWeight","type":"object","description":"ParcelInformationWeight"}}}}
```

## The ParcelInformationLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this parcelInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ParcelInformationLineItem","type":"object","description":"ParcelInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ParcelInformationLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"ParcelInformationLineItemForCreation","type":"object","description":"ParcelInformationLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ParcelInformationListResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationListResponse":{"properties":{"parcelInformationList":{"description":"the parcel information found by the given search criteria","items":{"$ref":"#/components/schemas/ParcelInformation"},"maxItems":500,"type":"array"},"total":{"description":"the total count of parcel information found by the given search criteria","type":"integer"}},"title":"ParcelInformationListResponse","type":"object","description":"ParcelInformationListResponse"},"ParcelInformation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"created":{"description":"Creation date of this parcelInformation","format":"date-time","type":"string"},"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"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationDimensions"}],"description":"Dimension information of this parcel information"},"facilityRef":{"description":"Reference to related facility","type":"string"},"id":{"description":"Unique identifier of this parcelInformation","type":"string"},"lastModified":{"description":"Last modification date of this parcelInformation","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process.","type":"string"},"parcelInformationLineItems":{"description":"Items that are contained in this parcel information","items":{"$ref":"#/components/schemas/ParcelInformationLineItem"},"maxItems":50,"minItems":0,"type":"array"},"processRef":{"description":"Reference to related process.","type":"string"},"shippingInformationRef":{"description":"Reference to related shipping information.","type":"string"},"shortId":{"description":"A short identifier that helps assigning a parcelInformation to a customer","type":"string"},"version":{"description":"Version number of this parcelInformation","type":"integer"},"weights":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeights"}],"description":"Weight information of this parcel information"}},"required":["id","version","created","lastModified","processRef","operativeProcessRef","facilityRef","shippingInformationRef","parcelInformationLineItems"],"title":"ParcelInformation","type":"object","description":"ParcelInformation"},"ParcelInformationDimensions":{"properties":{"decimalPlaces":{"description":"The number of decimal places the dimensions have. Max value is 2","maximum":2,"minimum":0,"type":"integer"},"height":{"description":"The height of the parcel without decimal places","minimum":1,"type":"integer"},"length":{"description":"The length of the parcel without decimal places","minimum":1,"type":"integer"},"unit":{"description":"The unit of the dimensions. For now only CENTIMETER is supported","enum":["CENTIMETER"],"type":"string"},"width":{"description":"The width of the parcel without decimal places","minimum":1,"type":"integer"}},"required":["height","width","length","unit","decimalPlaces"],"title":"ParcelInformationDimensions","type":"object","description":"ParcelInformationDimensions"},"ParcelInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this parcelInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ParcelInformationLineItem","type":"object","description":"ParcelInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ParcelInformationWeights":{"properties":{"autoCalculated":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight automatically calculated from the line items of this parcel information. The weights per item are taken from article.attributes (category: dimensions, key: weightPerUnit, type: NUMBER). Only if ALL items have this attribute a weight will be calculated. If at least one item does not have this attribute, autoCalculated will not be set."},"manuallySet":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight manually set for this parcel information"}},"title":"ParcelInformationWeights","type":"object","description":"ParcelInformationWeights"},"ParcelInformationWeight":{"properties":{"decimalPlaces":{"description":"The number of decimal places the weight has. Max value is 3","maximum":3,"minimum":0,"type":"integer"},"unit":{"description":"The unit of the weight. For now only GRAM is supported","enum":["GRAM"],"type":"string"},"weight":{"description":"The weight of the parcel without decimal places.","minimum":1,"type":"integer"}},"required":["unit","decimalPlaces","weight"],"title":"ParcelInformationWeight","type":"object","description":"ParcelInformationWeight"}}}}
```

## The ParcelInformationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"parcelInformationList":{"items":{"$ref":"#/components/schemas/ParcelInformation"},"type":"array"},"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","parcelInformationList"],"title":"ParcelInformationPaginatedResult","type":"object","description":"ParcelInformationPaginatedResult"},"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"},"ParcelInformation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"created":{"description":"Creation date of this parcelInformation","format":"date-time","type":"string"},"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"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationDimensions"}],"description":"Dimension information of this parcel information"},"facilityRef":{"description":"Reference to related facility","type":"string"},"id":{"description":"Unique identifier of this parcelInformation","type":"string"},"lastModified":{"description":"Last modification date of this parcelInformation","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process.","type":"string"},"parcelInformationLineItems":{"description":"Items that are contained in this parcel information","items":{"$ref":"#/components/schemas/ParcelInformationLineItem"},"maxItems":50,"minItems":0,"type":"array"},"processRef":{"description":"Reference to related process.","type":"string"},"shippingInformationRef":{"description":"Reference to related shipping information.","type":"string"},"shortId":{"description":"A short identifier that helps assigning a parcelInformation to a customer","type":"string"},"version":{"description":"Version number of this parcelInformation","type":"integer"},"weights":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeights"}],"description":"Weight information of this parcel information"}},"required":["id","version","created","lastModified","processRef","operativeProcessRef","facilityRef","shippingInformationRef","parcelInformationLineItems"],"title":"ParcelInformation","type":"object","description":"ParcelInformation"},"ParcelInformationDimensions":{"properties":{"decimalPlaces":{"description":"The number of decimal places the dimensions have. Max value is 2","maximum":2,"minimum":0,"type":"integer"},"height":{"description":"The height of the parcel without decimal places","minimum":1,"type":"integer"},"length":{"description":"The length of the parcel without decimal places","minimum":1,"type":"integer"},"unit":{"description":"The unit of the dimensions. For now only CENTIMETER is supported","enum":["CENTIMETER"],"type":"string"},"width":{"description":"The width of the parcel without decimal places","minimum":1,"type":"integer"}},"required":["height","width","length","unit","decimalPlaces"],"title":"ParcelInformationDimensions","type":"object","description":"ParcelInformationDimensions"},"ParcelInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this parcelInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ParcelInformationLineItem","type":"object","description":"ParcelInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ParcelInformationWeights":{"properties":{"autoCalculated":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight automatically calculated from the line items of this parcel information. The weights per item are taken from article.attributes (category: dimensions, key: weightPerUnit, type: NUMBER). Only if ALL items have this attribute a weight will be calculated. If at least one item does not have this attribute, autoCalculated will not be set."},"manuallySet":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight manually set for this parcel information"}},"title":"ParcelInformationWeights","type":"object","description":"ParcelInformationWeights"},"ParcelInformationWeight":{"properties":{"decimalPlaces":{"description":"The number of decimal places the weight has. Max value is 3","maximum":3,"minimum":0,"type":"integer"},"unit":{"description":"The unit of the weight. For now only GRAM is supported","enum":["GRAM"],"type":"string"},"weight":{"description":"The weight of the parcel without decimal places.","minimum":1,"type":"integer"}},"required":["unit","decimalPlaces","weight"],"title":"ParcelInformationWeight","type":"object","description":"ParcelInformationWeight"}}}}
```

## The ParcelInformationParcelInformationLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationParcelInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelInformationParcelInformationLineItemsArticleFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsArticleFilter"},"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"}}}}
```

## The ParcelInformationParcelInformationLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationParcelInformationLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelInformationParcelInformationLineItemsFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsFilter"},"ParcelInformationParcelInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelInformationParcelInformationLineItemsArticleFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsArticleFilter"},"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"}}}}
```

## The ParcelInformationParcelInformationLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationParcelInformationLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ParcelInformationParcelInformationLineItemsListFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsListFilter"},"ParcelInformationParcelInformationLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelInformationParcelInformationLineItemsFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsFilter"},"ParcelInformationParcelInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelInformationParcelInformationLineItemsArticleFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsArticleFilter"},"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"}}}}
```

## The ParcelInformationSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationSearchPayload":{"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/ParcelInformationSearchQuery"},"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/ParcelInformationSort"},"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":"ParcelInformationSearchPayload","type":"object","description":"ParcelInformationSearchPayload"},"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"},"ParcelInformationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ParcelInformationSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/ParcelInformationSearchQuery"},"maxItems":500,"type":"array"},"parcelInformationLineItems":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsListFilter"}],"description":"Nested list search by parcelInformationLineItems"},"shippingInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shippingInformationRef"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"}},"title":"ParcelInformationSearchQuery","type":"object","description":"ParcelInformationSearchQuery"},"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"},"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"},"ParcelInformationParcelInformationLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ParcelInformationParcelInformationLineItemsListFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsListFilter"},"ParcelInformationParcelInformationLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelInformationParcelInformationLineItemsFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsFilter"},"ParcelInformationParcelInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelInformationParcelInformationLineItemsArticleFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsArticleFilter"},"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"},"ParcelInformationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ParcelInformationSort","type":"object","description":"ParcelInformationSort"}}}}
```

## The ParcelInformationSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ParcelInformationSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/ParcelInformationSearchQuery"},"maxItems":500,"type":"array"},"parcelInformationLineItems":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsListFilter"}],"description":"Nested list search by parcelInformationLineItems"},"shippingInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shippingInformationRef"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"}},"title":"ParcelInformationSearchQuery","type":"object","description":"ParcelInformationSearchQuery"},"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"},"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"},"ParcelInformationParcelInformationLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ParcelInformationParcelInformationLineItemsListFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsListFilter"},"ParcelInformationParcelInformationLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationParcelInformationLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelInformationParcelInformationLineItemsFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsFilter"},"ParcelInformationParcelInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelInformationParcelInformationLineItemsArticleFilter","type":"object","description":"ParcelInformationParcelInformationLineItemsArticleFilter"},"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"}}}}
```

## The ParcelInformationSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ParcelInformationSort","type":"object","description":"ParcelInformationSort"}}}}
```

## The ParcelInformationWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ParcelInformation"}},"required":["payload"],"type":"object","title":"ParcelInformationWebHookEvent","description":"ParcelInformationWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ParcelInformation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"created":{"description":"Creation date of this parcelInformation","format":"date-time","type":"string"},"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"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationDimensions"}],"description":"Dimension information of this parcel information"},"facilityRef":{"description":"Reference to related facility","type":"string"},"id":{"description":"Unique identifier of this parcelInformation","type":"string"},"lastModified":{"description":"Last modification date of this parcelInformation","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process.","type":"string"},"parcelInformationLineItems":{"description":"Items that are contained in this parcel information","items":{"$ref":"#/components/schemas/ParcelInformationLineItem"},"maxItems":50,"minItems":0,"type":"array"},"processRef":{"description":"Reference to related process.","type":"string"},"shippingInformationRef":{"description":"Reference to related shipping information.","type":"string"},"shortId":{"description":"A short identifier that helps assigning a parcelInformation to a customer","type":"string"},"version":{"description":"Version number of this parcelInformation","type":"integer"},"weights":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeights"}],"description":"Weight information of this parcel information"}},"required":["id","version","created","lastModified","processRef","operativeProcessRef","facilityRef","shippingInformationRef","parcelInformationLineItems"],"title":"ParcelInformation","type":"object","description":"ParcelInformation"},"ParcelInformationDimensions":{"properties":{"decimalPlaces":{"description":"The number of decimal places the dimensions have. Max value is 2","maximum":2,"minimum":0,"type":"integer"},"height":{"description":"The height of the parcel without decimal places","minimum":1,"type":"integer"},"length":{"description":"The length of the parcel without decimal places","minimum":1,"type":"integer"},"unit":{"description":"The unit of the dimensions. For now only CENTIMETER is supported","enum":["CENTIMETER"],"type":"string"},"width":{"description":"The width of the parcel without decimal places","minimum":1,"type":"integer"}},"required":["height","width","length","unit","decimalPlaces"],"title":"ParcelInformationDimensions","type":"object","description":"ParcelInformationDimensions"},"ParcelInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this parcelInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ParcelInformationLineItem","type":"object","description":"ParcelInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ParcelInformationWeights":{"properties":{"autoCalculated":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight automatically calculated from the line items of this parcel information. The weights per item are taken from article.attributes (category: dimensions, key: weightPerUnit, type: NUMBER). Only if ALL items have this attribute a weight will be calculated. If at least one item does not have this attribute, autoCalculated will not be set."},"manuallySet":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight manually set for this parcel information"}},"title":"ParcelInformationWeights","type":"object","description":"ParcelInformationWeights"},"ParcelInformationWeight":{"properties":{"decimalPlaces":{"description":"The number of decimal places the weight has. Max value is 3","maximum":3,"minimum":0,"type":"integer"},"unit":{"description":"The unit of the weight. For now only GRAM is supported","enum":["GRAM"],"type":"string"},"weight":{"description":"The weight of the parcel without decimal places.","minimum":1,"type":"integer"}},"required":["unit","decimalPlaces","weight"],"title":"ParcelInformationWeight","type":"object","description":"ParcelInformationWeight"}}}}
```

## The ParcelInformationWeight object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationWeight":{"properties":{"decimalPlaces":{"description":"The number of decimal places the weight has. Max value is 3","maximum":3,"minimum":0,"type":"integer"},"unit":{"description":"The unit of the weight. For now only GRAM is supported","enum":["GRAM"],"type":"string"},"weight":{"description":"The weight of the parcel without decimal places.","minimum":1,"type":"integer"}},"required":["unit","decimalPlaces","weight"],"title":"ParcelInformationWeight","type":"object","description":"ParcelInformationWeight"}}}}
```

## The ParcelInformationWeights object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationWeights":{"properties":{"autoCalculated":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight automatically calculated from the line items of this parcel information. The weights per item are taken from article.attributes (category: dimensions, key: weightPerUnit, type: NUMBER). Only if ALL items have this attribute a weight will be calculated. If at least one item does not have this attribute, autoCalculated will not be set."},"manuallySet":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight manually set for this parcel information"}},"title":"ParcelInformationWeights","type":"object","description":"ParcelInformationWeights"},"ParcelInformationWeight":{"properties":{"decimalPlaces":{"description":"The number of decimal places the weight has. Max value is 3","maximum":3,"minimum":0,"type":"integer"},"unit":{"description":"The unit of the weight. For now only GRAM is supported","enum":["GRAM"],"type":"string"},"weight":{"description":"The weight of the parcel without decimal places.","minimum":1,"type":"integer"}},"required":["unit","decimalPlaces","weight"],"title":"ParcelInformationWeight","type":"object","description":"ParcelInformationWeight"}}}}
```

## The ParcelInformationWeightsForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInformationWeightsForCreation":{"properties":{"manuallySet":{"allOf":[{"$ref":"#/components/schemas/ParcelInformationWeight"}],"description":"Weight manually set for this parcel information"}},"required":["manuallySet"],"title":"ParcelInformationWeightsForCreation","type":"object","description":"ParcelInformationWeightsForCreation"},"ParcelInformationWeight":{"properties":{"decimalPlaces":{"description":"The number of decimal places the weight has. Max value is 3","maximum":3,"minimum":0,"type":"integer"},"unit":{"description":"The unit of the weight. For now only GRAM is supported","enum":["GRAM"],"type":"string"},"weight":{"description":"The weight of the parcel without decimal places.","minimum":1,"type":"integer"}},"required":["unit","decimalPlaces","weight"],"title":"ParcelInformationWeight","type":"object","description":"ParcelInformationWeight"}}}}
```

## The ParcelInvoiceFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelInvoiceFilter":{"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":"ParcelInvoiceFilter","type":"object","description":"ParcelInvoiceFilter"},"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"}}}}
```

## The ParcelItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object"}],"xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"}}}}
```

## The ParcelItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The ParcelItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelItemForCreation":{"allOf":[{"$ref":"#/components/schemas/LineItemForCreation"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"description":"Description of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Weight of a single item in gram. Deprecated - Use article.attribute.weightPerUnit instead","type":"integer"}},"required":["quantity"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelItemForCreation","description":"ParcelItemForCreation"},"LineItemForCreation":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"title":"LineItemForCreation","type":"object","description":"LineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"}}}}
```

## The ParcelItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelItemForUpdate":{"additionalProperties":false,"properties":{"id":{"description":"The id of this parcelItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"parcelItemArticleAttributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"weightInGram":{"description":"Weight of a single item in gram","nullable":true,"type":"integer"}},"required":["id"],"type":"object","title":"ParcelItemForUpdate","description":"ParcelItemForUpdate"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"}}}}
```

## The ParcelItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelItemsArticleFilter","type":"object","description":"ParcelItemsArticleFilter"},"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"}}}}
```

## The ParcelItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelItemsFilter","type":"object","description":"ParcelItemsFilter"},"ParcelItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelItemsArticleFilter","type":"object","description":"ParcelItemsArticleFilter"},"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"}}}}
```

## The ParcelItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ParcelItemsListFilter","type":"object","description":"ParcelItemsListFilter"},"ParcelItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelItemsFilter","type":"object","description":"ParcelItemsFilter"},"ParcelItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelItemsArticleFilter","type":"object","description":"ParcelItemsArticleFilter"},"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"}}}}
```

## The ParcelItemValue object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"}}}}
```

## The ParcelLabelClassification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelLabelClassification":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"name":{"description":"Name of the parcel label classification","type":"string"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassification","type":"object","description":"ParcelLabelClassification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"}}}}
```

## The ParcelLabelClassificationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelLabelClassificationForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name for parcel label classification"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/ParcelDimensions"}],"description":"Dimensions for this parcel label classification"},"services":{"allOf":[{"$ref":"#/components/schemas/ParcelLabelClassificationServices"}],"description":"Services available for this parcel label classification"}},"required":["nameLocalized","dimensions"],"title":"ParcelLabelClassificationForCreation","type":"object","description":"ParcelLabelClassificationForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"}}}}
```

## The ParcelLabelClassificationServices object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelLabelClassificationServices":{"properties":{"bulkyGoods":{"default":false,"description":"Indicates if this label classification is for bulky goods","type":"boolean"}},"title":"ParcelLabelClassificationServices","type":"object","description":"ParcelLabelClassificationServices"}}}}
```

## The ParcelLabelCreationFailedPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelLabelCreationFailedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"errorMessage":{"type":"string"}},"required":["errorMessage"],"type":"object","title":"ParcelLabelCreationFailedPayload","description":"ParcelLabelCreationFailedPayload"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ParcelLabelType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelLabelType":{"description":"Which kind of label you want to add to the parcel","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelLabelType"}}}}
```

## The ParcelLabelTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelLabelTypeEnum":{"description":"The type of possible Parcel Labels","enum":["return.pdf","all.pdf","send.pdf","customs.pdf","return.zpl","all.zpl","send.zpl","customs.zpl"],"type":"string","title":"ParcelLabelTypeEnum"}}}}
```

## The ParcelPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"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","parcels"],"title":"ParcelPaginatedResult","type":"object","description":"ParcelPaginatedResult"},"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"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs","workflowInformation"],"type":"object"}],"type":"object","title":"Parcel","description":"Parcel"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"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"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object"}],"xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The ParcelPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyParcel"},{"$ref":"#/components/schemas/ModifyParcelLoadUnit"}]},"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":"ParcelPatchActions"},"title":"ParcelPatchActions","description":"ParcelPatchActions"},"ModifyParcel":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyParcel', because you want to modify a Parcel","enum":["ModifyParcel"],"type":"string"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Only changable on status OPEN or FAILED of the existing Parcel","nullable":true,"type":"string"},"customAttributes":{"type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency","nullable":true,"type":"number"},"result":{"$ref":"#/components/schemas/ParcelResult"},"services":{"$ref":"#/components/schemas/ParcelServices"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantParcelId":{"type":"string"}},"required":["action"],"type":"object"}],"description":"Modify Parcel Action.","title":"ModifyParcelAction","xml":{"name":"ModifyParcel"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"ModifyParcelLoadUnit":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyParcelLoadUnit', because you want to modify loadunitRefs in Parcel","enum":["ModifyParcelLoadUnit"],"type":"string"},"loadUnitRefs":{"items":{"type":"string"},"type":"array"}},"required":["action","loadUnitRefs"],"type":"object"}],"description":"Modify Parcels of a LoadUnit.","title":"ModifyParcelLoadUnitsAction","xml":{"name":"ModifyParcelLoadUnit"}}}}}
```

## The ParcelPickUpInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"}}}}
```

## The ParcelPostalCharge object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"}}}}
```

## The ParcelProductValue object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelProductValue":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"ParcelProductValue","description":"ParcelProductValue"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The ParcelRecipientFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelRecipientFilter":{"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":"ParcelRecipientFilter","type":"object","description":"ParcelRecipientFilter"},"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"}}}}
```

## The ParcelResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"}}}}
```

## The ParcelResultFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelResultFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierTrackingNumber"}},"title":"ParcelResultFilter","type":"object","description":"ParcelResultFilter"},"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"}}}}
```

## The ParcelSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelSearchPayload":{"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/ParcelSearchQuery"},"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/ParcelSort"},"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":"ParcelSearchPayload","type":"object","description":"ParcelSearchPayload"},"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"},"ParcelSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ParcelSearchQuery"},"maxItems":500,"type":"array"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoice":{"allOf":[{"$ref":"#/components/schemas/ParcelInvoiceFilter"}],"description":"Nested search by invoice"},"items":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsListFilter"}],"description":"Nested list search by items"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/ParcelSearchQuery"},"maxItems":500,"type":"array"},"recipient":{"allOf":[{"$ref":"#/components/schemas/ParcelRecipientFilter"}],"description":"Nested search by recipient"},"result":{"allOf":[{"$ref":"#/components/schemas/ParcelResultFilter"}],"description":"Nested search by result"},"shipmentRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shipmentRef"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/ParcelStatusEnumFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ParcelSearchQuery","type":"object","description":"ParcelSearchQuery"},"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"},"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"},"ParcelInvoiceFilter":{"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":"ParcelInvoiceFilter","type":"object","description":"ParcelInvoiceFilter"},"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"},"ParcelItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ParcelItemsListFilter","type":"object","description":"ParcelItemsListFilter"},"ParcelItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelItemsFilter","type":"object","description":"ParcelItemsFilter"},"ParcelItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelItemsArticleFilter","type":"object","description":"ParcelItemsArticleFilter"},"ParcelRecipientFilter":{"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":"ParcelRecipientFilter","type":"object","description":"ParcelRecipientFilter"},"ParcelResultFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierTrackingNumber"}},"title":"ParcelResultFilter","type":"object","description":"ParcelResultFilter"},"ParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ParcelStatusEnumFilter","type":"object","description":"ParcelStatusEnumFilter"},"ParcelSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ParcelSort","type":"object","description":"ParcelSort"}}}}
```

## The ParcelSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ParcelSearchQuery"},"maxItems":500,"type":"array"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoice":{"allOf":[{"$ref":"#/components/schemas/ParcelInvoiceFilter"}],"description":"Nested search by invoice"},"items":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsListFilter"}],"description":"Nested list search by items"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/ParcelSearchQuery"},"maxItems":500,"type":"array"},"recipient":{"allOf":[{"$ref":"#/components/schemas/ParcelRecipientFilter"}],"description":"Nested search by recipient"},"result":{"allOf":[{"$ref":"#/components/schemas/ParcelResultFilter"}],"description":"Nested search by result"},"shipmentRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shipmentRef"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/ParcelStatusEnumFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ParcelSearchQuery","type":"object","description":"ParcelSearchQuery"},"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"},"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"},"ParcelInvoiceFilter":{"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":"ParcelInvoiceFilter","type":"object","description":"ParcelInvoiceFilter"},"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"},"ParcelItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ParcelItemsListFilter","type":"object","description":"ParcelItemsListFilter"},"ParcelItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelItemsFilter","type":"object","description":"ParcelItemsFilter"},"ParcelItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelItemsArticleFilter","type":"object","description":"ParcelItemsArticleFilter"},"ParcelRecipientFilter":{"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":"ParcelRecipientFilter","type":"object","description":"ParcelRecipientFilter"},"ParcelResultFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierTrackingNumber"}},"title":"ParcelResultFilter","type":"object","description":"ParcelResultFilter"},"ParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ParcelStatusEnumFilter","type":"object","description":"ParcelStatusEnumFilter"}}}}
```

## The ParcelServices object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"}}}}
```

## The ParcelSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ParcelSort","type":"object","description":"ParcelSort"}}}}
```

## The ParcelSplitItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelSplitItemsActionEnum":{"enum":["SPLIT_LINES_PARCEL"],"type":"string","title":"ParcelSplitItemsActionEnum","description":"ParcelSplitItemsActionEnum"}}}}
```

## The ParcelSplitItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelSplitItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ParcelSplitItemsActionEnum"},"splitItemsInfo":{"items":{"$ref":"#/components/schemas/ParcelSplitItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitItemsInfo"],"title":"ParcelSplitItemsActionParameter","type":"object","description":"ParcelSplitItemsActionParameter"},"ParcelSplitItemsActionEnum":{"enum":["SPLIT_LINES_PARCEL"],"type":"string","title":"ParcelSplitItemsActionEnum","description":"ParcelSplitItemsActionEnum"},"ParcelSplitItemsInfo":{"additionalProperties":false,"properties":{"itemId":{"description":"references the id of the item of a parcel","type":"string"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["itemId","quantity"],"type":"object","title":"ParcelSplitItemsInfo","description":"ParcelSplitItemsInfo"}}}}
```

## The ParcelSplitItemsInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelSplitItemsInfo":{"additionalProperties":false,"properties":{"itemId":{"description":"references the id of the item of a parcel","type":"string"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["itemId","quantity"],"type":"object","title":"ParcelSplitItemsInfo","description":"ParcelSplitItemsInfo"}}}}
```

## The ParcelStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"}}}}
```

## The ParcelStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ParcelStatusEnumFilter","type":"object","description":"ParcelStatusEnumFilter"}}}}
```

## The ParcelTagConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"alternativeReturnAddressConfiguration":{"$ref":"#/components/schemas/AlternativeReturnAddressConfiguration"}},"required":["alternativeReturnAddressConfiguration"],"title":"ParcelTagConfiguration","description":"ParcelTagConfiguration"},"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"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"AlternativeReturnAddressConfiguration":{"additionalProperties":false,"properties":{"alternativeReturnAddressPerTag":{"items":{"$ref":"#/components/schemas/AlternativeReturnAddressPerTag"},"minItems":0,"type":"array"}},"required":["alternativeReturnAddressPerTag"],"title":"AlternativeReturnAddressConfiguration","description":"AlternativeReturnAddressConfiguration"},"AlternativeReturnAddressPerTag":{"additionalProperties":false,"properties":{"alternativeReturnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"tagRef":{"description":"needs to be an existing tag id","type":"string"}},"required":["tagRef","matchingValues","alternativeReturnAddress"],"title":"AlternativeReturnAddressPerTag","description":"AlternativeReturnAddressPerTag"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The ParcelTagConfigurationForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelTagConfigurationForUpsert":{"allOf":[{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"alternativeReturnAddressConfiguration":{"$ref":"#/components/schemas/AlternativeReturnAddressConfiguration"},"version":{"type":"number"}},"required":["alternativeReturnAddressConfiguration"],"title":"ParcelTagConfigurationForUpsert","description":"ParcelTagConfigurationForUpsert"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"AlternativeReturnAddressConfiguration":{"additionalProperties":false,"properties":{"alternativeReturnAddressPerTag":{"items":{"$ref":"#/components/schemas/AlternativeReturnAddressPerTag"},"minItems":0,"type":"array"}},"required":["alternativeReturnAddressPerTag"],"title":"AlternativeReturnAddressConfiguration","description":"AlternativeReturnAddressConfiguration"},"AlternativeReturnAddressPerTag":{"additionalProperties":false,"properties":{"alternativeReturnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"tagRef":{"description":"needs to be an existing tag id","type":"string"}},"required":["tagRef","matchingValues","alternativeReturnAddress"],"title":"AlternativeReturnAddressPerTag","description":"AlternativeReturnAddressPerTag"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The ParcelTrackingData object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelTrackingData":{"additionalProperties":false,"properties":{"carrierStatus":{"description":"Optional additional carrier tracker information","type":"string"},"status":{"$ref":"#/components/schemas/ParcelTrackingDataStatusEnum"},"trackingNumber":{"description":"123456789","type":"string"},"type":{"$ref":"#/components/schemas/ParcelTrackingDataType"}},"required":["type","status","trackingNumber"],"title":"ParcelTrackingData","type":"object","description":"ParcelTrackingData"},"ParcelTrackingDataStatusEnum":{"description":"Status of the given enum to be mapped onto the found parcel","enum":["DELIVERED","PICKED_UP"],"type":"string","title":"ParcelTrackingDataStatusEnum"},"ParcelTrackingDataType":{"description":"Which kind of tracking data you want to add to the parcel label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelTrackingDataType"}}}}
```

## The ParcelTrackingDataStatusEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelTrackingDataStatusEnum":{"description":"Status of the given enum to be mapped onto the found parcel","enum":["DELIVERED","PICKED_UP"],"type":"string","title":"ParcelTrackingDataStatusEnum"}}}}
```

## The ParcelTrackingDataType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelTrackingDataType":{"description":"Which kind of tracking data you want to add to the parcel label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelTrackingDataType"}}}}
```

## The ParcelUpdateTrackingDataActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelUpdateTrackingDataActionEnum":{"enum":["UPDATE_TRACKING_DATA"],"type":"string","title":"ParcelUpdateTrackingDataActionEnum","description":"ParcelUpdateTrackingDataActionEnum"}}}}
```

## The ParcelUpdateTrackingDataActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelUpdateTrackingDataActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ParcelUpdateTrackingDataActionEnum"},"trackingData":{"items":{"anyOf":[{"$ref":"#/components/schemas/ParcelTrackingData"}]},"maxItems":2,"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","trackingData"],"title":"ParcelUpdateTrackingDataActionParameter","type":"object","description":"ParcelUpdateTrackingDataActionParameter"},"ParcelUpdateTrackingDataActionEnum":{"enum":["UPDATE_TRACKING_DATA"],"type":"string","title":"ParcelUpdateTrackingDataActionEnum","description":"ParcelUpdateTrackingDataActionEnum"},"ParcelTrackingData":{"additionalProperties":false,"properties":{"carrierStatus":{"description":"Optional additional carrier tracker information","type":"string"},"status":{"$ref":"#/components/schemas/ParcelTrackingDataStatusEnum"},"trackingNumber":{"description":"123456789","type":"string"},"type":{"$ref":"#/components/schemas/ParcelTrackingDataType"}},"required":["type","status","trackingNumber"],"title":"ParcelTrackingData","type":"object","description":"ParcelTrackingData"},"ParcelTrackingDataStatusEnum":{"description":"Status of the given enum to be mapped onto the found parcel","enum":["DELIVERED","PICKED_UP"],"type":"string","title":"ParcelTrackingDataStatusEnum"},"ParcelTrackingDataType":{"description":"Which kind of tracking data you want to add to the parcel label","enum":["SEND_LABEL","RETURN_LABEL"],"type":"string","title":"ParcelTrackingDataType"}}}}
```

## The ParcelWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ParcelWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Parcel"}},"required":["payload"],"type":"object","title":"ParcelWebHookEvent","description":"ParcelWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs","workflowInformation"],"type":"object"}],"type":"object","title":"Parcel","description":"Parcel"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"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"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object"}],"xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The PartialStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"}}}}
```

## The PartialStockForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"}}}}
```

## The PartialStockLocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PartialStockLocation":{"properties":{"stockRef":{"nullable":true,"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"title":"PartialStockLocation","type":"object","description":"PartialStockLocation"}}}}
```

## The PartialStockPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PartialStockPatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyPartialStock"},"maxItems":1,"minItems":1,"type":"array"},"version":{"description":"The version of the listing where we want to patch the partialStocks, to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"PartialStockPatchActions"},"title":"PartialStockPatchActions","description":"PartialStockPatchActions"},"ModifyPartialStock":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPartialStock', because you want to modify a partial stock","enum":["ModifyPartialStock"],"type":"string"},"partialStocks":{"items":{"$ref":"#/components/schemas/PartialStockForCreation"},"minItems":0,"type":"array"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyPartialStock"},"title":"ModifyPartialStock","description":"ModifyPartialStock"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"}}}}
```

## The PartialStocksForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PartialStocksForReplacement":{"additionalProperties":false,"properties":{"partialStocks":{"items":{"$ref":"#/components/schemas/PartialStockForCreation"},"minItems":1,"type":"array"},"version":{"description":"The version of the listing where we want to put the partialStocks, to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["partialStocks","version"],"type":"object","xml":{"name":"PartialStocksForReplacement"},"title":"PartialStocksForReplacement","description":"PartialStocksForReplacement"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"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"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"}}}}
```

## The PauseItemReturnActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PauseItemReturnActionParameter":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"enum":["PauseItemReturn"],"type":"string"}},"required":["name","itemReturnJobVersion"],"title":"PauseItemReturnActionParameter","type":"object","description":"PauseItemReturnActionParameter"}}}}
```

## The PausePackJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PausePackJob":{"additionalProperties":false,"description":"Action to pause a PackJob","properties":{"action":{"description":"Use value 'PausePackJob', because you want to pause a packjob","enum":["PausePackJob"],"type":"string"},"packLineItemsUpdate":{"items":{"$ref":"#/components/schemas/PackLineItemForUpdate"},"type":"array"}},"required":["action"],"title":"PausePackJob","type":"object","xml":{"name":"PausePackJob"}},"PackLineItemForUpdate":{"properties":{"id":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this packline. Can't be more than picked before.","format":"int64","minimum":0,"type":"integer"}},"required":["id","packed"],"type":"object","xml":{"name":"PackLineItemForUpdate"},"title":"PackLineItemForUpdate","description":"PackLineItemForUpdate"}}}}
```

## The PauseStowJobAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PauseStowJobAction":{"description":"Sets the status of the stowjob to PAUSED","properties":{"name":{"description":"The name of the action that should be performed","enum":["PAUSE_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"PauseStowJobAction","type":"object"}}}}
```

## The PaymentInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"}}}}
```

## The PdfBackgroundConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PdfBackgroundConfiguration":{"properties":{"firstPageBackgroundFileUrl":{"description":"File url of the background image that will be used for the first page","type":"string"},"followingPageBackgroundFileUrl":{"description":"File url of background image that will be used for 2-n pages","type":"string"}},"type":"object","title":"PdfBackgroundConfiguration","description":"PdfBackgroundConfiguration"}}}}
```

## The PdfBackgroundConfigurationForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PdfBackgroundConfigurationForUpsert":{"properties":{"firstPageBackgroundFile":{"$ref":"#/components/schemas/NamedFile"},"followingPageBackgroundFile":{"$ref":"#/components/schemas/NamedFile"}},"type":"object","title":"PdfBackgroundConfigurationForUpsert","description":"PdfBackgroundConfigurationForUpsert"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"}}}}
```

## The Permission object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Permission":{"properties":{"description":{"description":"The localized description of the permission","type":"string"},"group":{"description":"The group of the permission","enum":["INVENTORY","ORDER_MANAGEMENT","SYSTEM_ADMINISTRATION","FOUNDATION","USER_MANAGEMENT","OPERATIONS","ADMIN","CORE"],"type":"string"},"key":{"description":"The key of the permission","enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"operation":{"description":"The operation of the permission","enum":["READ","WRITE","DELETE","REROUTE","LIST","MODIFY","CREATE","RESET","FORCE_CANCEL","UNLOCK","CANCEL","CONSUMER_WRITE","CUSTOM_ATTRIBUTES_WRITE","LINEITEM_WRITE","DELIVERY_PROMISE_WRITE","TOTAL_READ","PRICING_READ","QUANTITY_INCREASE","QUANTITY_DECREASE","ADD"],"type":"string"},"subGroup":{"description":"The subgroup of the permission","enum":["ORDER","LINE_ITEM","SIMULATION_ORDER","USER","CURRENT_USER","ROLE","EXPIRY","AUDIT","FACILITY","FACILITY_GROUP","CONFIG","ROUTING_CONFIG","ROUTING","OIDC_PROVIDER_CONFIG","PROMISES_CONFIG","LOCALE","CARRIER","RETURN","PARCEL","SHIPMENT","HANDOVERJOB","HANDOVER_JOB","PICKJOB","PICK_JOB","PICKRUN","PICK_RUN","PACKJOB","PACK_JOB","PACKING_SOURCE_CONTAINER","PACKINGCONTAINER_TYPE","PACKING_CONTAINER_TYPE","RESTOW_ITEM","TAG","STOCK","EXTERNAL_STOCK_CHANGE_REASONS","STORAGE_LOCATION","STOW_JOB","NOTIFICATION","NOTIFICATION_CENTER_CONFIG","DOMS_TOOLKIT","ANALYTICS_DASHBOARD","DOCUMENT_SET","INBOUND_PROCESS","TENANT_CONNECTOR_CONFIG","ADMIN_MODULES","CUSTOM_SERVICE","VALIDATIONS","SERVICE_JOB","LINKED_SERVICE_JOBS","OPERATION_STATISTICS","DOMS_STATISTICS","AVAILABILITY_CHANNEL","HANDOVER_CONTAINER","STACKS","CATEGORY","PERMISSION","AI_SIDEKICK","KPI","LOADUNIT_TYPE","LOAD_UNIT_TYPE","LOADUNIT","LOAD_UNIT","MEASUREMENT_UNIT","EVENT","SUBSCRIPTION","SUBSTITUTE","PROCESS","PROCESS_LOGS","EXTERNAL_ACTIONS","OPERATIVE_PROCESS","DELIVERYNOTE","REMOTE_CONFIG","ADMIN_DATA","RESERVATION","FILTER_ENTITY","BRAND","WORKFLOW_DEFINITION","LOOKUP_RECORD","ORDER_RECORD","PACKAGING_UNITS","EXPORT","STOCK_AVAILABILITIES","LISTING","PURCHASE_PRICE","ZONE","SAFETY_STOCK","AVAILABILITY_THRESHOLDS","PICKUP_SERVICE"],"type":"string"}},"required":["operation","key","group","subGroup"],"title":"Permission","type":"object","description":"Permission"}}}}
```

## The PermissionsResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PermissionsResponse":{"properties":{"permissions":{"description":"The list of permissions","items":{"$ref":"#/components/schemas/Permission"},"type":"array"},"total":{"description":"The total number of (filtered) permissions","type":"number"}},"required":["permissions","total"],"title":"PermissionsResponse","type":"object","description":"PermissionsResponse"},"Permission":{"properties":{"description":{"description":"The localized description of the permission","type":"string"},"group":{"description":"The group of the permission","enum":["INVENTORY","ORDER_MANAGEMENT","SYSTEM_ADMINISTRATION","FOUNDATION","USER_MANAGEMENT","OPERATIONS","ADMIN","CORE"],"type":"string"},"key":{"description":"The key of the permission","enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"operation":{"description":"The operation of the permission","enum":["READ","WRITE","DELETE","REROUTE","LIST","MODIFY","CREATE","RESET","FORCE_CANCEL","UNLOCK","CANCEL","CONSUMER_WRITE","CUSTOM_ATTRIBUTES_WRITE","LINEITEM_WRITE","DELIVERY_PROMISE_WRITE","TOTAL_READ","PRICING_READ","QUANTITY_INCREASE","QUANTITY_DECREASE","ADD"],"type":"string"},"subGroup":{"description":"The subgroup of the permission","enum":["ORDER","LINE_ITEM","SIMULATION_ORDER","USER","CURRENT_USER","ROLE","EXPIRY","AUDIT","FACILITY","FACILITY_GROUP","CONFIG","ROUTING_CONFIG","ROUTING","OIDC_PROVIDER_CONFIG","PROMISES_CONFIG","LOCALE","CARRIER","RETURN","PARCEL","SHIPMENT","HANDOVERJOB","HANDOVER_JOB","PICKJOB","PICK_JOB","PICKRUN","PICK_RUN","PACKJOB","PACK_JOB","PACKING_SOURCE_CONTAINER","PACKINGCONTAINER_TYPE","PACKING_CONTAINER_TYPE","RESTOW_ITEM","TAG","STOCK","EXTERNAL_STOCK_CHANGE_REASONS","STORAGE_LOCATION","STOW_JOB","NOTIFICATION","NOTIFICATION_CENTER_CONFIG","DOMS_TOOLKIT","ANALYTICS_DASHBOARD","DOCUMENT_SET","INBOUND_PROCESS","TENANT_CONNECTOR_CONFIG","ADMIN_MODULES","CUSTOM_SERVICE","VALIDATIONS","SERVICE_JOB","LINKED_SERVICE_JOBS","OPERATION_STATISTICS","DOMS_STATISTICS","AVAILABILITY_CHANNEL","HANDOVER_CONTAINER","STACKS","CATEGORY","PERMISSION","AI_SIDEKICK","KPI","LOADUNIT_TYPE","LOAD_UNIT_TYPE","LOADUNIT","LOAD_UNIT","MEASUREMENT_UNIT","EVENT","SUBSCRIPTION","SUBSTITUTE","PROCESS","PROCESS_LOGS","EXTERNAL_ACTIONS","OPERATIVE_PROCESS","DELIVERYNOTE","REMOTE_CONFIG","ADMIN_DATA","RESERVATION","FILTER_ENTITY","BRAND","WORKFLOW_DEFINITION","LOOKUP_RECORD","ORDER_RECORD","PACKAGING_UNITS","EXPORT","STOCK_AVAILABILITIES","LISTING","PURCHASE_PRICE","ZONE","SAFETY_STOCK","AVAILABILITY_THRESHOLDS","PICKUP_SERVICE"],"type":"string"}},"required":["operation","key","group","subGroup"],"title":"Permission","type":"object","description":"Permission"}}}}
```

## The PickingConfigurations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingConfigurations":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"backofficePickingConfiguration":{"$ref":"#/components/schemas/BackofficePickingConfiguration"},"batchPickingConfiguration":{"$ref":"#/components/schemas/BatchPickingConfiguration"},"domainStatusConfiguration":{"$ref":"#/components/schemas/PickingDomainStatusConfiguration"},"loadUnitAssignmentConfiguration":{"$ref":"#/components/schemas/LoadUnitAssignmentConfiguration"},"multiOrderPickingConfiguration":{"$ref":"#/components/schemas/MultiOrderPickingConfiguration"},"pickingMethodsConfiguration":{"$ref":"#/components/schemas/PickingMethodsConfiguration"},"pickingShortPickConfiguration":{"$ref":"#/components/schemas/PickingShortPickConfiguration"},"restartPickJobConfiguration":{"$ref":"#/components/schemas/RestartPickJobConfiguration"},"scanCodeValidationConfiguration":{"$ref":"#/components/schemas/PickingScanCodeValidationConfiguration"},"scanningConfiguration":{"$ref":"#/components/schemas/PickingScanningConfiguration"},"scheduledPickJobReleaseConfiguration":{"$ref":"#/components/schemas/ScheduledPickJobReleaseConfiguration"},"stockUpdateConfiguration":{"$ref":"#/components/schemas/PickingStockUpdateConfiguration"},"storageLocationAssignmentConfiguration":{"$ref":"#/components/schemas/StorageLocationAssignmentConfiguration"},"takeOverPickJobConfiguration":{"$ref":"#/components/schemas/TakeOverPickJobConfiguration"},"takeOverPickRunConfiguration":{"$ref":"#/components/schemas/TakeOverPickRunConfiguration"}},"type":"object","title":"PickingConfigurations","description":"PickingConfigurations"},"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"},"BackofficePickingConfiguration":{"description":"Can this tenant use the backoffice for picking?","properties":{"active":{"default":false,"type":"boolean"}},"required":["active"],"type":"object","title":"BackofficePickingConfiguration"},"BatchPickingConfiguration":{"additionalProperties":false,"properties":{"maxAmountOfPickJobsForBatchPick":{"description":"The maximum amount of pick jobs that can be combined in a batch pick. Must be a value between 1 and 100.","maximum":100,"minimum":1,"type":"integer"}},"required":["maxAmountOfPickJobsForBatchPick"],"type":"object","title":"BatchPickingConfiguration","description":"BatchPickingConfiguration"},"PickingDomainStatusConfiguration":{"additionalProperties":false,"description":"Configuration for the picking status to domainStatus mapping","properties":{"mapAbortedToFinished":{"default":false,"description":"If true, the pickJob status ABORTED will be mapped to the domainStatus FINISHED instead of STUCK","type":"boolean"}},"type":"object","title":"PickingDomainStatusConfiguration"},"LoadUnitAssignmentConfiguration":{"description":"Who do the load units need to be assigned in pickJob (SingleOrderPick) and pickRun (MultiOrderPick)","properties":{"pickJob":{"$ref":"#/components/schemas/LoadUnitAssignmentType"},"pickRun":{"$ref":"#/components/schemas/LoadUnitAssignmentType"}},"required":["pickJob","pickRun"],"type":"object","title":"LoadUnitAssignmentConfiguration"},"LoadUnitAssignmentType":{"description":"Where do the load unit needs to be assigned?","enum":["INACTIVE","AT_START","AT_END","DURING_PICKING"],"type":"string","title":"LoadUnitAssignmentType"},"MultiOrderPickingConfiguration":{"additionalProperties":false,"properties":{"maxAmountOfPickJobsForMultiOrderPick":{"description":"The maximum amount of pick jobs that can be combined in a multi order pick. Must be a value between 1 and 100.","maximum":100,"minimum":1,"type":"integer"}},"required":["maxAmountOfPickJobsForMultiOrderPick"],"type":"object","title":"MultiOrderPickingConfiguration","description":"MultiOrderPickingConfiguration"},"PickingMethodsConfiguration":{"properties":{"defaultPickingMethod":{"$ref":"#/components/schemas/PickingMethodEnum"}},"required":["defaultPickingMethod"],"type":"object","title":"PickingMethodsConfiguration","description":"PickingMethodsConfiguration"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingShortPickConfiguration":{"properties":{"confirmationOnShortPick":{"default":false,"description":"Does the picker needs to confirm a stock correction before adding a short pick","type":"boolean"},"shortPickReasons":{"items":{"$ref":"#/components/schemas/ShortPickReason"},"type":"array"}},"required":["confirmationOnShortPick"],"type":"object","title":"PickingShortPickConfiguration","description":"PickingShortPickConfiguration"},"ShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"active":{"description":"Flag to mark a reason as active or inactive","type":"boolean"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["active","reasonLocalized"],"title":"ShortPickReason","description":"ShortPickReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"RestartPickJobConfiguration":{"properties":{"active":{"default":true,"type":"boolean"}},"required":["active"],"type":"object","title":"RestartPickJobConfiguration","description":"RestartPickJobConfiguration"},"PickingScanCodeValidationConfiguration":{"properties":{"pickingScanCodeValidationType":{"$ref":"#/components/schemas/PickingScanCodeValidationEnum"}},"required":["pickingScanCodeValidationType"],"type":"object","title":"PickingScanCodeValidationConfiguration","description":"PickingScanCodeValidationConfiguration"},"PickingScanCodeValidationEnum":{"description":"State that defines if unknown scan codes can be accepted","enum":["NO_VALIDATION","CODE_MUST_BE_KNOWN"],"type":"string","title":"PickingScanCodeValidationEnum"},"PickingScanningConfiguration":{"properties":{"rolesWithOverwritingScanningPermission":{"items":{"$ref":"#/components/schemas/UserRoleNames"},"minItems":1,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"scanningType":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"}},"type":"object","title":"PickingScanningConfiguration","description":"PickingScanningConfiguration"},"UserRoleNames":{"description":"All available user roles","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string","xml":{"name":"UserRoleNames"},"title":"UserRoleNames"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"ScheduledPickJobReleaseConfiguration":{"properties":{"openPickJobLeadTimeInMinutes":{"description":"This config describes when a scheduled PickJob should be released and made available for picking (pickjob.pickingTimes.latest - openPickJobLeadTimeInMinutes = time when the PickJob should be released).","type":"integer"}},"required":["openPickJobLeadTimeInMinutes"],"type":"object","title":"ScheduledPickJobReleaseConfiguration","description":"ScheduledPickJobReleaseConfiguration"},"PickingStockUpdateConfiguration":{"properties":{"active":{"default":false,"description":"Enable or disable stock update check for pick jobs","type":"boolean"}},"required":["active"],"type":"object","title":"PickingStockUpdateConfiguration","description":"PickingStockUpdateConfiguration"},"StorageLocationAssignmentConfiguration":{"additionalProperties":false,"properties":{"storageLocationRequired":{"enum":["ALL","SOME","NONE"],"type":"string"}},"required":["storageLocationRequired"],"type":"object","title":"StorageLocationAssignmentConfiguration","description":"StorageLocationAssignmentConfiguration"},"TakeOverPickJobConfiguration":{"properties":{"active":{"default":false,"description":"Enable or disable pick job takeover","type":"boolean"}},"required":["active"],"type":"object","title":"TakeOverPickJobConfiguration","description":"TakeOverPickJobConfiguration"},"TakeOverPickRunConfiguration":{"properties":{"active":{"default":false,"description":"Enable or disable pick run takeover","type":"boolean"}},"required":["active"],"type":"object","title":"TakeOverPickRunConfiguration","description":"TakeOverPickRunConfiguration"}}}}
```

## The PickingDomainStatusConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingDomainStatusConfiguration":{"additionalProperties":false,"description":"Configuration for the picking status to domainStatus mapping","properties":{"mapAbortedToFinished":{"default":false,"description":"If true, the pickJob status ABORTED will be mapped to the domainStatus FINISHED instead of STUCK","type":"boolean"}},"type":"object","title":"PickingDomainStatusConfiguration"}}}}
```

## The PickingLoadUnitForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingLoadUnitForCreation":{"properties":{"codes":{"description":"List of codes","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"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"},"loadUnitLineItems":{"items":{"$ref":"#/components/schemas/LoadUnitLineItemForCreation"},"maxItems":100,"type":"array"},"loadUnitTypeRef":{"deprecated":true,"description":"Use operativeContainerTypeRef instead.","type":"string"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"},"stackRef":{"description":"the reference to the stackRef this loadUnit is part of","type":"string"},"storageLocationRef":{"description":"the reference to the storage location this load unit as been placed into","type":"string"}},"required":["codes"],"title":"PickingLoadUnitForCreation","type":"object","description":"PickingLoadUnitForCreation"},"LoadUnitLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"customAttributes":{"type":"object"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article"],"title":"LoadUnitLineItemForCreation","type":"object","description":"LoadUnitLineItemForCreation"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The PickingMethodEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"}}}}
```

## The PickingMethodsConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingMethodsConfiguration":{"properties":{"defaultPickingMethod":{"$ref":"#/components/schemas/PickingMethodEnum"}},"required":["defaultPickingMethod"],"type":"object","title":"PickingMethodsConfiguration","description":"PickingMethodsConfiguration"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"}}}}
```

## The PickingOutcomeConfigSnapshot object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingOutcomeConfigSnapshot":{"properties":{"shortPickActiveDefaulted":{"description":"True when shortpick.active config was absent and defaulted to true","type":"boolean"},"stockToZeroOnEmptyPartialStockLocationActive":{"description":"Whether stock should be set to zero on empty partial stock location","type":"boolean"},"stockToZeroOnShortPickActive":{"description":"Whether stock should be set to zero on short pick","type":"boolean"}},"required":["stockToZeroOnShortPickActive","stockToZeroOnEmptyPartialStockLocationActive","shortPickActiveDefaulted"],"title":"PickingOutcomeConfigSnapshot","type":"object","description":"PickingOutcomeConfigSnapshot"}}}}
```

## The PickingOutcomeDiagnostic object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingOutcomeDiagnostic":{"properties":{"code":{"$ref":"#/components/schemas/DiagnosticCode"}},"required":["code"],"title":"PickingOutcomeDiagnostic","type":"object","description":"PickingOutcomeDiagnostic"},"DiagnosticCode":{"description":"Indicates the specific reason a picking diagnostic was raised.\n\nSTOCK_SHORT_PICK => The quantity picked from a partial stock location was below the requested quantity, while short-pick handling was enabled for this configuration.\n\nLINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was below the requested quantity.\n\nSTOCK_NOT_FOUND => The specified stock reference or tenant stock ID could not be found.\n\nINSUFFICIENT_STOCK => The target stock did not have enough available quantity to fulfill the request.","enum":["STOCK_SHORT_PICK","LINE_ITEM_SHORT_PICK","STOCK_NOT_FOUND","INSUFFICIENT_STOCK"],"type":"string","xml":{"name":"DiagnosticCode"},"title":"DiagnosticCode"}}}}
```

## The PickingOutcomeEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingOutcomeEventPayload":{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/PickingOutcomeConfigSnapshot"}],"description":"Job-wide config snapshot"},"header":{"$ref":"#/components/schemas/PickingOutcomeHeader"},"reasons":{"description":"Unique list of all DiagnosticCodes","items":{"$ref":"#/components/schemas/DiagnosticCode"},"type":"array"},"records":{"items":{"$ref":"#/components/schemas/PickingOutcomeRecord"},"type":"array"}},"required":["header","config","reasons","records"],"title":"PickingOutcomeEventPayload","type":"object","description":"PickingOutcomeEventPayload"},"PickingOutcomeConfigSnapshot":{"properties":{"shortPickActiveDefaulted":{"description":"True when shortpick.active config was absent and defaulted to true","type":"boolean"},"stockToZeroOnEmptyPartialStockLocationActive":{"description":"Whether stock should be set to zero on empty partial stock location","type":"boolean"},"stockToZeroOnShortPickActive":{"description":"Whether stock should be set to zero on short pick","type":"boolean"}},"required":["stockToZeroOnShortPickActive","stockToZeroOnEmptyPartialStockLocationActive","shortPickActiveDefaulted"],"title":"PickingOutcomeConfigSnapshot","type":"object","description":"PickingOutcomeConfigSnapshot"},"PickingOutcomeHeader":{"properties":{"facilityRef":{"type":"string"},"jobRef":{"type":"string"},"jobType":{"$ref":"#/components/schemas/PickingOutcomeHeaderJobType"},"orderRef":{"type":"string"},"processRef":{"type":"string"},"routingPlanRef":{"type":"string"},"tenantOrderId":{"type":"string"}},"required":["jobRef","facilityRef"],"title":"PickingOutcomeHeader","type":"object","description":"PickingOutcomeHeader"},"PickingOutcomeHeaderJobType":{"description":"PickingOutcome Source Trigger","enum":["PICK_JOB","HANDOVER_JOB","CHAINED_SUPPLIER"],"type":"string","xml":{"name":"PickingOutcomeHeaderJobType"},"title":"PickingOutcomeHeaderJobType"},"DiagnosticCode":{"description":"Indicates the specific reason a picking diagnostic was raised.\n\nSTOCK_SHORT_PICK => The quantity picked from a partial stock location was below the requested quantity, while short-pick handling was enabled for this configuration.\n\nLINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was below the requested quantity.\n\nSTOCK_NOT_FOUND => The specified stock reference or tenant stock ID could not be found.\n\nINSUFFICIENT_STOCK => The target stock did not have enough available quantity to fulfill the request.","enum":["STOCK_SHORT_PICK","LINE_ITEM_SHORT_PICK","STOCK_NOT_FOUND","INSUFFICIENT_STOCK"],"type":"string","xml":{"name":"DiagnosticCode"},"title":"DiagnosticCode"},"PickingOutcomeRecord":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"},"lineItemId":{"description":"Depending on the trigger this holds the pickLineItem.id from a pickJob or handoverJobLineItem.id from an handoverJob","type":"string"},"partialStockLocation":{"$ref":"#/components/schemas/PartialStockLocation"},"provided":{"$ref":"#/components/schemas/ProvidedSection"},"reduction":{"$ref":"#/components/schemas/ReductionSection"},"stockSelection":{"$ref":"#/components/schemas/StockSelectionSection"},"substituteLocationRef":{"type":"string"}},"required":["provided","stockSelection","reduction","diagnostics"],"title":"PickingOutcomeRecord","type":"object","description":"PickingOutcomeRecord"},"PickingOutcomeDiagnostic":{"properties":{"code":{"$ref":"#/components/schemas/DiagnosticCode"}},"required":["code"],"title":"PickingOutcomeDiagnostic","type":"object","description":"PickingOutcomeDiagnostic"},"PartialStockLocation":{"properties":{"stockRef":{"nullable":true,"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"title":"PartialStockLocation","type":"object","description":"PartialStockLocation"},"ProvidedSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"ProvidedSection","type":"object","description":"ProvidedSection"},"ReductionSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"ReductionSection","type":"object","description":"ReductionSection"},"StockSelectionSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"StockSelectionSection","type":"object","description":"StockSelectionSection"}}}}
```

## The PickingOutcomeHeader object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingOutcomeHeader":{"properties":{"facilityRef":{"type":"string"},"jobRef":{"type":"string"},"jobType":{"$ref":"#/components/schemas/PickingOutcomeHeaderJobType"},"orderRef":{"type":"string"},"processRef":{"type":"string"},"routingPlanRef":{"type":"string"},"tenantOrderId":{"type":"string"}},"required":["jobRef","facilityRef"],"title":"PickingOutcomeHeader","type":"object","description":"PickingOutcomeHeader"},"PickingOutcomeHeaderJobType":{"description":"PickingOutcome Source Trigger","enum":["PICK_JOB","HANDOVER_JOB","CHAINED_SUPPLIER"],"type":"string","xml":{"name":"PickingOutcomeHeaderJobType"},"title":"PickingOutcomeHeaderJobType"}}}}
```

## The PickingOutcomeHeaderJobType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingOutcomeHeaderJobType":{"description":"PickingOutcome Source Trigger","enum":["PICK_JOB","HANDOVER_JOB","CHAINED_SUPPLIER"],"type":"string","xml":{"name":"PickingOutcomeHeaderJobType"},"title":"PickingOutcomeHeaderJobType"}}}}
```

## The PickingOutcomeRecord object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingOutcomeRecord":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"},"lineItemId":{"description":"Depending on the trigger this holds the pickLineItem.id from a pickJob or handoverJobLineItem.id from an handoverJob","type":"string"},"partialStockLocation":{"$ref":"#/components/schemas/PartialStockLocation"},"provided":{"$ref":"#/components/schemas/ProvidedSection"},"reduction":{"$ref":"#/components/schemas/ReductionSection"},"stockSelection":{"$ref":"#/components/schemas/StockSelectionSection"},"substituteLocationRef":{"type":"string"}},"required":["provided","stockSelection","reduction","diagnostics"],"title":"PickingOutcomeRecord","type":"object","description":"PickingOutcomeRecord"},"PickingOutcomeDiagnostic":{"properties":{"code":{"$ref":"#/components/schemas/DiagnosticCode"}},"required":["code"],"title":"PickingOutcomeDiagnostic","type":"object","description":"PickingOutcomeDiagnostic"},"DiagnosticCode":{"description":"Indicates the specific reason a picking diagnostic was raised.\n\nSTOCK_SHORT_PICK => The quantity picked from a partial stock location was below the requested quantity, while short-pick handling was enabled for this configuration.\n\nLINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was below the requested quantity.\n\nSTOCK_NOT_FOUND => The specified stock reference or tenant stock ID could not be found.\n\nINSUFFICIENT_STOCK => The target stock did not have enough available quantity to fulfill the request.","enum":["STOCK_SHORT_PICK","LINE_ITEM_SHORT_PICK","STOCK_NOT_FOUND","INSUFFICIENT_STOCK"],"type":"string","xml":{"name":"DiagnosticCode"},"title":"DiagnosticCode"},"PartialStockLocation":{"properties":{"stockRef":{"nullable":true,"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"title":"PartialStockLocation","type":"object","description":"PartialStockLocation"},"ProvidedSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"ProvidedSection","type":"object","description":"ProvidedSection"},"ReductionSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"ReductionSection","type":"object","description":"ReductionSection"},"StockSelectionSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"StockSelectionSection","type":"object","description":"StockSelectionSection"}}}}
```

## The PickingOutcomeWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingOutcomeWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/PickingOutcomeEventPayload"}},"required":["payload"],"title":"PickingOutcomeWebHookEvent","type":"object","description":"PickingOutcomeWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"PickingOutcomeEventPayload":{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/PickingOutcomeConfigSnapshot"}],"description":"Job-wide config snapshot"},"header":{"$ref":"#/components/schemas/PickingOutcomeHeader"},"reasons":{"description":"Unique list of all DiagnosticCodes","items":{"$ref":"#/components/schemas/DiagnosticCode"},"type":"array"},"records":{"items":{"$ref":"#/components/schemas/PickingOutcomeRecord"},"type":"array"}},"required":["header","config","reasons","records"],"title":"PickingOutcomeEventPayload","type":"object","description":"PickingOutcomeEventPayload"},"PickingOutcomeConfigSnapshot":{"properties":{"shortPickActiveDefaulted":{"description":"True when shortpick.active config was absent and defaulted to true","type":"boolean"},"stockToZeroOnEmptyPartialStockLocationActive":{"description":"Whether stock should be set to zero on empty partial stock location","type":"boolean"},"stockToZeroOnShortPickActive":{"description":"Whether stock should be set to zero on short pick","type":"boolean"}},"required":["stockToZeroOnShortPickActive","stockToZeroOnEmptyPartialStockLocationActive","shortPickActiveDefaulted"],"title":"PickingOutcomeConfigSnapshot","type":"object","description":"PickingOutcomeConfigSnapshot"},"PickingOutcomeHeader":{"properties":{"facilityRef":{"type":"string"},"jobRef":{"type":"string"},"jobType":{"$ref":"#/components/schemas/PickingOutcomeHeaderJobType"},"orderRef":{"type":"string"},"processRef":{"type":"string"},"routingPlanRef":{"type":"string"},"tenantOrderId":{"type":"string"}},"required":["jobRef","facilityRef"],"title":"PickingOutcomeHeader","type":"object","description":"PickingOutcomeHeader"},"PickingOutcomeHeaderJobType":{"description":"PickingOutcome Source Trigger","enum":["PICK_JOB","HANDOVER_JOB","CHAINED_SUPPLIER"],"type":"string","xml":{"name":"PickingOutcomeHeaderJobType"},"title":"PickingOutcomeHeaderJobType"},"DiagnosticCode":{"description":"Indicates the specific reason a picking diagnostic was raised.\n\nSTOCK_SHORT_PICK => The quantity picked from a partial stock location was below the requested quantity, while short-pick handling was enabled for this configuration.\n\nLINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was below the requested quantity.\n\nSTOCK_NOT_FOUND => The specified stock reference or tenant stock ID could not be found.\n\nINSUFFICIENT_STOCK => The target stock did not have enough available quantity to fulfill the request.","enum":["STOCK_SHORT_PICK","LINE_ITEM_SHORT_PICK","STOCK_NOT_FOUND","INSUFFICIENT_STOCK"],"type":"string","xml":{"name":"DiagnosticCode"},"title":"DiagnosticCode"},"PickingOutcomeRecord":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"},"lineItemId":{"description":"Depending on the trigger this holds the pickLineItem.id from a pickJob or handoverJobLineItem.id from an handoverJob","type":"string"},"partialStockLocation":{"$ref":"#/components/schemas/PartialStockLocation"},"provided":{"$ref":"#/components/schemas/ProvidedSection"},"reduction":{"$ref":"#/components/schemas/ReductionSection"},"stockSelection":{"$ref":"#/components/schemas/StockSelectionSection"},"substituteLocationRef":{"type":"string"}},"required":["provided","stockSelection","reduction","diagnostics"],"title":"PickingOutcomeRecord","type":"object","description":"PickingOutcomeRecord"},"PickingOutcomeDiagnostic":{"properties":{"code":{"$ref":"#/components/schemas/DiagnosticCode"}},"required":["code"],"title":"PickingOutcomeDiagnostic","type":"object","description":"PickingOutcomeDiagnostic"},"PartialStockLocation":{"properties":{"stockRef":{"nullable":true,"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"title":"PartialStockLocation","type":"object","description":"PartialStockLocation"},"ProvidedSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"ProvidedSection","type":"object","description":"ProvidedSection"},"ReductionSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"ReductionSection","type":"object","description":"ReductionSection"},"StockSelectionSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"StockSelectionSection","type":"object","description":"StockSelectionSection"}}}}
```

## The PickingPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyPickLineItem"},{"$ref":"#/components/schemas/ModifyPickJob"},{"$ref":"#/components/schemas/ModifyPickJobLastEditor"},{"$ref":"#/components/schemas/RestartPickJob"},{"$ref":"#/components/schemas/ResetPickJob"},{"$ref":"#/components/schemas/AbortPickJob"}]},"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"],"xml":{"name":"PickingPatchActions"},"title":"PickingPatchActions","description":"PickingPatchActions"},"ModifyPickLineItem":{"allOf":[{"additionalProperties":false,"properties":{"shortPickReasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyPickLineItem', because you want to modify a pick line item","enum":["ModifyPickLineItem"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"scannedCodes":{"description":"Scanned Codes of the given picked line item","items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minItems":0},"secondaryPicked":{"type":"integer"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItemForUpsert"},"type":"array"}},"required":["id","action"],"type":"object"}],"description":"Action to modify a picklineitem of a PickJob.","title":"ModifyPickLineItem","xml":{"name":"ModifyPickLineItem"}},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItemForUpsert":{"properties":{"id":{"description":"The id of the substitute line item to update. If none is passed, a new substitute line item will be created.","type":"string"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"tenantArticleId":{"description":"TenantArticleId of the substitute article","type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"SubstituteLineItemForUpsert","description":"SubstituteLineItemForUpsert"},"ModifyPickJob":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPickJob', because you want to modify a pickjob","enum":["ModifyPickJob"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the pickJob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"preferredPickingMethods":{"description":"Preferred way of picking a given pickJob.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"status":{"$ref":"#/components/schemas/PickJobStatusUnprotected"}},"required":["action"],"type":"object"}],"description":"Action to modify a PickJob.","title":"ModifyPickJob","xml":{"name":"ModifyPickJob"}},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickJobStatusUnprotected":{"description":"The status of a pickjob. These are the status that are still allowed to be used in the deprecated status field of ModifyPickJob actions","enum":["OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","PAUSED","WAITING_FOR_INPUT"],"type":"string","xml":{"name":"PickJobStatusUnprotected"},"title":"PickJobStatusUnprotected"},"ModifyPickJobLastEditor":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPickJobLastEditor' to set the last editor to your user and therefor take over the pickjob.","enum":["ModifyPickJobLastEditor"],"type":"string"}},"required":["action"],"type":"object"}],"description":"Action to modify the last editor of a PickJob.","title":"ModifyPickJobLastEditor","xml":{"name":"ModifyPickJobLastEditor"}},"RestartPickJob":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'RestartPickJob' to restart the pickJob and set it back to status IN_PROGRESS.","enum":["RestartPickJob"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickjobs/:id/actions instead","title":"RestartPickJob","xml":{"name":"RestartPickJob"}},"ResetPickJob":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ResetPickJob' to reset the pickJob and set it back to status OPEN and reset the pick line items.","enum":["ResetPickJob"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickjobs/:id/actions instead","title":"ResetPickJob","xml":{"name":"ResetPickJob"}},"AbortPickJob":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'AbortPickJob', because you want to cancel a pickjob","enum":["AbortPickJob"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickjobs/:id/actions instead","title":"AbortPickJob","xml":{"name":"AbortPickJob"}}}}}
```

## The PickingScanCodeValidationConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingScanCodeValidationConfiguration":{"properties":{"pickingScanCodeValidationType":{"$ref":"#/components/schemas/PickingScanCodeValidationEnum"}},"required":["pickingScanCodeValidationType"],"type":"object","title":"PickingScanCodeValidationConfiguration","description":"PickingScanCodeValidationConfiguration"},"PickingScanCodeValidationEnum":{"description":"State that defines if unknown scan codes can be accepted","enum":["NO_VALIDATION","CODE_MUST_BE_KNOWN"],"type":"string","title":"PickingScanCodeValidationEnum"}}}}
```

## The PickingScanCodeValidationEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingScanCodeValidationEnum":{"description":"State that defines if unknown scan codes can be accepted","enum":["NO_VALIDATION","CODE_MUST_BE_KNOWN"],"type":"string","title":"PickingScanCodeValidationEnum"}}}}
```

## The PickingScanningConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingScanningConfiguration":{"properties":{"rolesWithOverwritingScanningPermission":{"items":{"$ref":"#/components/schemas/UserRoleNames"},"minItems":1,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"scanningType":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"}},"type":"object","title":"PickingScanningConfiguration","description":"PickingScanningConfiguration"},"UserRoleNames":{"description":"All available user roles","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string","xml":{"name":"UserRoleNames"},"title":"UserRoleNames"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"}}}}
```

## The PickingScanningConfigurationEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"}}}}
```

## The PickingShortPickConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingShortPickConfiguration":{"properties":{"confirmationOnShortPick":{"default":false,"description":"Does the picker needs to confirm a stock correction before adding a short pick","type":"boolean"},"shortPickReasons":{"items":{"$ref":"#/components/schemas/ShortPickReason"},"type":"array"}},"required":["confirmationOnShortPick"],"type":"object","title":"PickingShortPickConfiguration","description":"PickingShortPickConfiguration"},"ShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"active":{"description":"Flag to mark a reason as active or inactive","type":"boolean"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["active","reasonLocalized"],"title":"ShortPickReason","description":"ShortPickReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The PickingStartBase object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"}}}}
```

## The PickingStockProperty object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"}}}}
```

## The PickingStockPropertyPreset object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"}}}}
```

## The PickingStockUpdateConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingStockUpdateConfiguration":{"properties":{"active":{"default":false,"description":"Enable or disable stock update check for pick jobs","type":"boolean"}},"required":["active"],"type":"object","title":"PickingStockUpdateConfiguration","description":"PickingStockUpdateConfiguration"}}}}
```

## The PickingTimes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"}}}}
```

## The PickingZone object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickingZone":{"description":"Zones from which items can be picked","properties":{"zoneRef":{"type":"string"}},"required":["zoneRef"],"type":"object","title":"PickingZone"}}}}
```

## The PickJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJob":{"allOf":[{"$ref":"#/components/schemas/PickJobForCreation"},{"$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"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformation"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItem"},"type":"array"},"id":{"description":"The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"pickingZones":{"items":{"$ref":"#/components/schemas/PickingZone"},"type":"array"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItem"},"type":"array"},"pickRunRef":{"description":"Pick run id to which the pick job belongs","type":"string"},"resetBlocked":{"default":false,"description":"Indicates if pickJob can still be resetted or restarted","type":"boolean"},"shortId":{"description":"A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"statusReason":{"deprecated":true,"description":"deprecated: Use subStatus instead. Maintained for backward compatibility.","type":"string"},"subStatus":{"$ref":"#/components/schemas/PickJobSubStatus","description":"The reason for the current status."},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","status","pickLineItems","shortId","workflowInformation","deliveryinformation","documentsRef"],"type":"object"}],"title":"PickJob","description":"PickJob"},"PickJobForCreation":{"additionalProperties":false,"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},"minItems":0,"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order reference. The given ID has to be present in the system.","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickingTimes":{"$ref":"#/components/schemas/PickJobPickingTimes"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItemForCreation"},"minItems":0,"type":"array"},"preferredPickingMethods":{"description":"Preferred way of picking a given pickJob.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"routingPlanRef":{"description":"Reference to the routingplan which created this pickjob","type":"string"},"shortId":{"description":"A short identifier that helps assigning a pick job to a customer.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"minItems":0,"type":"array"},"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"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"description":"Tags can only be set when there is no process related with this pickJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["orderDate","facilityRef","pickLineItems"],"type":"object","xml":{"name":"Pickjob"},"title":"PickJobForCreation","description":"PickJobForCreation"},"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"},"PickjobDeliveryInformationForCreation":{"properties":{"channel":{"$ref":"#/components/schemas/PickJobDeliveryInformationChannel"},"details":{"properties":{"collect":{"properties":{"identifier":{"description":"Includes information about Click & Collect recipient","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"}},"type":"object"},"shipping":{"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label, this is specific to a carrier","type":"string"},"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"identifier":{"description":"Includes information on how to identify Ship from Store recipient (Name, PIN, Reference number, ...)","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientaddress":{"$ref":"#/components/schemas/ConsumerAddress"},"serviceLevel":{"description":"TBD","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object"}},"type":"object"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"}},"type":"object","title":"PickjobDeliveryInformationForCreation","description":"PickjobDeliveryInformationForCreation"},"PickJobDeliveryInformationChannel":{"enum":["COLLECT","SHIPPING"],"type":"string","title":"PickJobDeliveryInformationChannel","description":"PickJobDeliveryInformationChannel"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ExpectedPickLineItemForCreation":{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["transferId","quantity","article"],"title":"ExpectedPickLineItemForCreation","description":"ExpectedPickLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"PickJobPickingTimes":{"additionalProperties":false,"properties":{"startLatestAt":{"description":"The date this pickJob should be started at last.","format":"date-time","type":"string"}},"type":"object","title":"PickJobPickingTimes","description":"PickJobPickingTimes"},"PickLineItemForCreation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"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"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"PickLineItemForCreation","description":"PickLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickJobStatus":{"description":"The status of a pickjob.","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string","xml":{"name":"PickJobStatus"},"title":"PickJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"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"},"PickjobDeliveryInformation":{"allOf":[{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},{"required":["channel"]}],"type":"object","title":"PickjobDeliveryInformation","description":"PickjobDeliveryInformation"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ExpectedPickLineItem":{"allOf":[{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["id"],"type":"object"}],"title":"ExpectedPickLineItem","description":"ExpectedPickLineItem"},"PickingZone":{"description":"Zones from which items can be picked","properties":{"zoneRef":{"type":"string"}},"required":["zoneRef"],"type":"object","title":"PickingZone"},"PickLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. 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":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"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"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickLineItem","description":"PickLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"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"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"PickJobSubStatus":{"description":"The reason for the current status, providing type-safe context beyond the status field.","enum":["SHORT_PICKED","ZERO_PICKED","WAITING_FOR_RELEASE_TIME","ORDER_MODIFIED","PROCESS_REROUTE","MANUAL_REROUTE","SHORT_PICK_REROUTE","TIME_TRIGGERED","STOCK_ZEROED","PICK_JOB_ABORTED","RECALCULATION"],"type":"string","xml":{"name":"PickJobSubStatus"},"title":"PickJobSubStatus"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"}}}}
```

## The PickJobAbortActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobAbortActionEnum":{"enum":["ABORT"],"type":"string","title":"PickJobAbortActionEnum","description":"PickJobAbortActionEnum"}}}}
```

## The PickJobAbortActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobAbortActionParameter":{"additionalProperties":false,"description":"Action to Abort a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobAbortActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobAbortActionParameter","type":"object"},"PickJobAbortActionEnum":{"enum":["ABORT"],"type":"string","title":"PickJobAbortActionEnum","description":"PickJobAbortActionEnum"}}}}
```

## The PickJobActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/PickJobAbortActionParameter"},{"$ref":"#/components/schemas/PickJobRestartActionParameter"},{"$ref":"#/components/schemas/PickJobResetActionParameter"},{"$ref":"#/components/schemas/PickJobObsoleteActionParameter"},{"$ref":"#/components/schemas/PickJobReplaceAssignedUsersActionParameter"},{"$ref":"#/components/schemas/PickJobPauseActionParameter"},{"$ref":"#/components/schemas/PickJobStartActionParameter"},{"$ref":"#/components/schemas/PickJobSplitLineItemsActionParameter"},{"$ref":"#/components/schemas/PickJobMergeLineItemsActionParameter"},{"$ref":"#/components/schemas/UpdatePickLineItemRecordableAttributesActionParameter"},{"$ref":"#/components/schemas/PickJobPickedActionParameter"},{"$ref":"#/components/schemas/ModifyPickLineItemsActionParameter"},{"$ref":"#/components/schemas/PickJobAddTargetTimeActionParameter"},{"$ref":"#/components/schemas/PickJobCancelActionParameter"},{"$ref":"#/components/schemas/PickJobCloseActionParameter"}],"title":"PickJobActionsParameter","description":"PickJobActionsParameter"},"PickJobAbortActionParameter":{"additionalProperties":false,"description":"Action to Abort a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobAbortActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobAbortActionParameter","type":"object"},"PickJobAbortActionEnum":{"enum":["ABORT"],"type":"string","title":"PickJobAbortActionEnum","description":"PickJobAbortActionEnum"},"PickJobRestartActionParameter":{"additionalProperties":false,"description":"Action to Restart a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobRestartActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobRestartActionParameter","type":"object"},"PickJobRestartActionEnum":{"enum":["RESTART"],"type":"string","title":"PickJobRestartActionEnum","description":"PickJobRestartActionEnum"},"PickJobResetActionParameter":{"additionalProperties":false,"description":"Action to reset a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobResetActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobResetActionParameter","type":"object"},"PickJobResetActionEnum":{"enum":["RESET"],"type":"string","title":"PickJobResetActionEnum","description":"PickJobResetActionEnum"},"PickJobObsoleteActionParameter":{"additionalProperties":false,"description":"Action to set the status to Obsolete of a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobObsoleteActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobObsoleteActionParameter","type":"object"},"PickJobObsoleteActionEnum":{"enum":["OBSOLETE"],"type":"string","title":"PickJobObsoleteActionEnum","description":"PickJobObsoleteActionEnum"},"PickJobReplaceAssignedUsersActionParameter":{"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/PickJobReplaceAssignedUsersActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","assignedUsers"],"title":"PickJobReplaceAssignedUsersActionParameter"},"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"},"PickJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"PickJobReplaceAssignedUsersActionEnum","description":"PickJobReplaceAssignedUsersActionEnum"},"PickJobPauseActionParameter":{"additionalProperties":false,"description":"Action to pause a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobPauseActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobPauseActionParameter","type":"object"},"PickJobPauseActionEnum":{"enum":["PAUSE"],"type":"string","title":"PickJobPauseActionEnum","description":"PickJobPauseActionEnum"},"PickJobStartActionParameter":{"additionalProperties":false,"description":"Action to start a PickJob by setting it and its line items to IN_PROGRESS.","properties":{"name":{"$ref":"#/components/schemas/PickJobStartActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobStartActionParameter","type":"object"},"PickJobStartActionEnum":{"enum":["START"],"type":"string","title":"PickJobStartActionEnum","description":"PickJobStartActionEnum"},"PickJobSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/PickJobSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/PickJobSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"PickJobSplitLineItemsActionParameter","type":"object","description":"PickJobSplitLineItemsActionParameter"},"PickJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINE_ITEMS_PICK_JOB"],"type":"string","title":"PickJobSplitLineItemsActionEnum","description":"PickJobSplitLineItemsActionEnum"},"PickJobSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the pickLineItem of a pickJob","type":"string"},"picked":{"description":"The amount of articles that were picked for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity","picked"],"type":"object","title":"PickJobSplitLineItemsInfo","description":"PickJobSplitLineItemsInfo"},"PickJobMergeLineItemsActionParameter":{"additionalProperties":false,"properties":{"lineItemIds":{"description":"Ids of the line items that should be merged","items":{"type":"string"},"type":"array"},"name":{"$ref":"#/components/schemas/PickJobMergeLineItemsActionEnum"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","lineItemIds"],"title":"PickJobMergeLineItemsActionParameter","type":"object","description":"PickJobMergeLineItemsActionParameter"},"PickJobMergeLineItemsActionEnum":{"enum":["MERGE_LINE_ITEMS_PICK_JOB"],"type":"string","title":"PickJobMergeLineItemsActionEnum","description":"PickJobMergeLineItemsActionEnum"},"UpdatePickLineItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdatePickLineItemRecordableAttributesActionEnum"},"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":"UpdatePickLineItemRecordableAttributesActionParameter","type":"object","description":"UpdatePickLineItemRecordableAttributesActionParameter"},"UpdatePickLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_PICK_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdatePickLineItemRecordableAttributesActionEnum","description":"UpdatePickLineItemRecordableAttributesActionEnum"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickJobPickedActionParameter":{"additionalProperties":false,"description":"Action to set the status to Picked of a Pickjob.","properties":{"lineItems":{"description":"Pick line items that should be updated ","items":{"$ref":"#/components/schemas/PickPickJobPickLineItemUpdate"},"maxItems":100,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/PickJobPickedActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","lineItems"],"title":"PickJobPickedActionParameter","type":"object"},"PickPickJobPickLineItemUpdate":{"additionalProperties":false,"properties":{"customAttributes":{"description":"Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"},"maxItems":50,"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked. example: '2024-02-03T08:45:51.525Z' format: date-time type: string"},"scannedCodes":{"description":"Scanned Codes of the given picked line item","items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"maxItems":50,"minItems":0,"type":"array"},"secondaryPicked":{"type":"integer"},"shortPickReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}}},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItemForUpsert"},"maxItems":50,"type":"array"}},"required":["id"],"type":"object","title":"PickPickJobPickLineItemUpdate","description":"PickPickJobPickLineItemUpdate"},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItemForUpsert":{"properties":{"id":{"description":"The id of the substitute line item to update. If none is passed, a new substitute line item will be created.","type":"string"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"tenantArticleId":{"description":"TenantArticleId of the substitute article","type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"SubstituteLineItemForUpsert","description":"SubstituteLineItemForUpsert"},"PickJobPickedActionEnum":{"enum":["PICK"],"type":"string","title":"PickJobPickedActionEnum","description":"PickJobPickedActionEnum"},"ModifyPickLineItemsActionParameter":{"additionalProperties":false,"description":"Action to modify picklineItems of a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/ModifyPickJobLineItemsActionEnum"},"pickJobLineItemUpdates":{"items":{"$ref":"#/components/schemas/PickLineItemUpdate"},"minItems":1,"type":"array"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","pickJobLineItemUpdates"],"title":"ModifyPickLineItemsActionParameter","type":"object"},"ModifyPickJobLineItemsActionEnum":{"enum":["MODIFY_PICK_JOB_LINE_ITEMS"],"type":"string","title":"ModifyPickJobLineItemsActionEnum","description":"ModifyPickJobLineItemsActionEnum"},"PickLineItemUpdate":{"additionalProperties":false,"properties":{"customAttributes":{"description":"Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"},"maxItems":50,"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"scannedCodes":{"description":"Scanned Codes of the given picked line item","items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"maxItems":50,"minItems":0,"type":"array"},"secondaryPicked":{"type":"integer"},"shortPickReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}}},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItemForUpsert"},"maxItems":50,"type":"array"}},"required":["id"],"type":"object","title":"PickLineItemUpdate","description":"PickLineItemUpdate"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"PickJobAddTargetTimeActionParameter":{"additionalProperties":false,"description":"Action to add targetTime to a PickJob that has none. Will fail if targetTime is already set","properties":{"name":{"$ref":"#/components/schemas/PickJobAddTargetTimeActionEnum"},"targetTime":{"description":"The target time you want set for the given pickJob.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"PickJobAddTargetTimeActionParameter"},"PickJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"PickJobAddTargetTimeActionEnum","description":"PickJobAddTargetTimeActionEnum"},"PickJobCancelActionParameter":{"additionalProperties":false,"description":"Action to cancel a Pickjob. ","properties":{"name":{"$ref":"#/components/schemas/PickJobCancelActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobCancelActionParameter","type":"object"},"PickJobCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"PickJobCancelActionEnum","description":"PickJobCancelActionEnum"},"PickJobCloseActionParameter":{"additionalProperties":false,"description":"Action to close a PickJob. Directly setting a pickJob to CLOSED will skip non zero shortPick actions like rerouting, setting subStatus to SHORT_PICKED instead. If none of the pickLineItems have been picked, the pickJob will be set to ABORTED instead of CLOSED.","properties":{"name":{"$ref":"#/components/schemas/PickJobCloseActionEnum"},"version":{"description":"Version of the entity to be closed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobCloseActionParameter","type":"object"},"PickJobCloseActionEnum":{"enum":["CLOSE"],"type":"string","title":"PickJobCloseActionEnum","description":"PickJobCloseActionEnum"}}}}
```

## The PickJobAddTargetTimeActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"PickJobAddTargetTimeActionEnum","description":"PickJobAddTargetTimeActionEnum"}}}}
```

## The PickJobAddTargetTimeActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobAddTargetTimeActionParameter":{"additionalProperties":false,"description":"Action to add targetTime to a PickJob that has none. Will fail if targetTime is already set","properties":{"name":{"$ref":"#/components/schemas/PickJobAddTargetTimeActionEnum"},"targetTime":{"description":"The target time you want set for the given pickJob.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"PickJobAddTargetTimeActionParameter"},"PickJobAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"PickJobAddTargetTimeActionEnum","description":"PickJobAddTargetTimeActionEnum"}}}}
```

## The PickJobCancelActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"PickJobCancelActionEnum","description":"PickJobCancelActionEnum"}}}}
```

## The PickJobCancelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobCancelActionParameter":{"additionalProperties":false,"description":"Action to cancel a Pickjob. ","properties":{"name":{"$ref":"#/components/schemas/PickJobCancelActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobCancelActionParameter","type":"object"},"PickJobCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"PickJobCancelActionEnum","description":"PickJobCancelActionEnum"}}}}
```

## The PickJobCloseActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobCloseActionEnum":{"enum":["CLOSE"],"type":"string","title":"PickJobCloseActionEnum","description":"PickJobCloseActionEnum"}}}}
```

## The PickJobCloseActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobCloseActionParameter":{"additionalProperties":false,"description":"Action to close a PickJob. Directly setting a pickJob to CLOSED will skip non zero shortPick actions like rerouting, setting subStatus to SHORT_PICKED instead. If none of the pickLineItems have been picked, the pickJob will be set to ABORTED instead of CLOSED.","properties":{"name":{"$ref":"#/components/schemas/PickJobCloseActionEnum"},"version":{"description":"Version of the entity to be closed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobCloseActionParameter","type":"object"},"PickJobCloseActionEnum":{"enum":["CLOSE"],"type":"string","title":"PickJobCloseActionEnum","description":"PickJobCloseActionEnum"}}}}
```

## The PickjobDeliveryInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickjobDeliveryInformation":{"allOf":[{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},{"required":["channel"]}],"type":"object","title":"PickjobDeliveryInformation","description":"PickjobDeliveryInformation"},"PickjobDeliveryInformationForCreation":{"properties":{"channel":{"$ref":"#/components/schemas/PickJobDeliveryInformationChannel"},"details":{"properties":{"collect":{"properties":{"identifier":{"description":"Includes information about Click & Collect recipient","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"}},"type":"object"},"shipping":{"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label, this is specific to a carrier","type":"string"},"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"identifier":{"description":"Includes information on how to identify Ship from Store recipient (Name, PIN, Reference number, ...)","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientaddress":{"$ref":"#/components/schemas/ConsumerAddress"},"serviceLevel":{"description":"TBD","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object"}},"type":"object"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"}},"type":"object","title":"PickjobDeliveryInformationForCreation","description":"PickjobDeliveryInformationForCreation"},"PickJobDeliveryInformationChannel":{"enum":["COLLECT","SHIPPING"],"type":"string","title":"PickJobDeliveryInformationChannel","description":"PickJobDeliveryInformationChannel"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"}}}}
```

## The PickJobDeliveryInformationChannel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobDeliveryInformationChannel":{"enum":["COLLECT","SHIPPING"],"type":"string","title":"PickJobDeliveryInformationChannel","description":"PickJobDeliveryInformationChannel"}}}}
```

## The PickjobDeliveryInformationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickjobDeliveryInformationForCreation":{"properties":{"channel":{"$ref":"#/components/schemas/PickJobDeliveryInformationChannel"},"details":{"properties":{"collect":{"properties":{"identifier":{"description":"Includes information about Click & Collect recipient","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"}},"type":"object"},"shipping":{"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label, this is specific to a carrier","type":"string"},"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"identifier":{"description":"Includes information on how to identify Ship from Store recipient (Name, PIN, Reference number, ...)","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientaddress":{"$ref":"#/components/schemas/ConsumerAddress"},"serviceLevel":{"description":"TBD","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object"}},"type":"object"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"}},"type":"object","title":"PickjobDeliveryInformationForCreation","description":"PickjobDeliveryInformationForCreation"},"PickJobDeliveryInformationChannel":{"enum":["COLLECT","SHIPPING"],"type":"string","title":"PickJobDeliveryInformationChannel","description":"PickJobDeliveryInformationChannel"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"}}}}
```

## The PickJobForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobForCreation":{"additionalProperties":false,"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},"minItems":0,"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order reference. The given ID has to be present in the system.","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickingTimes":{"$ref":"#/components/schemas/PickJobPickingTimes"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItemForCreation"},"minItems":0,"type":"array"},"preferredPickingMethods":{"description":"Preferred way of picking a given pickJob.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"routingPlanRef":{"description":"Reference to the routingplan which created this pickjob","type":"string"},"shortId":{"description":"A short identifier that helps assigning a pick job to a customer.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"minItems":0,"type":"array"},"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"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"description":"Tags can only be set when there is no process related with this pickJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["orderDate","facilityRef","pickLineItems"],"type":"object","xml":{"name":"Pickjob"},"title":"PickJobForCreation","description":"PickJobForCreation"},"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"},"PickjobDeliveryInformationForCreation":{"properties":{"channel":{"$ref":"#/components/schemas/PickJobDeliveryInformationChannel"},"details":{"properties":{"collect":{"properties":{"identifier":{"description":"Includes information about Click & Collect recipient","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"}},"type":"object"},"shipping":{"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label, this is specific to a carrier","type":"string"},"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"identifier":{"description":"Includes information on how to identify Ship from Store recipient (Name, PIN, Reference number, ...)","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientaddress":{"$ref":"#/components/schemas/ConsumerAddress"},"serviceLevel":{"description":"TBD","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object"}},"type":"object"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"}},"type":"object","title":"PickjobDeliveryInformationForCreation","description":"PickjobDeliveryInformationForCreation"},"PickJobDeliveryInformationChannel":{"enum":["COLLECT","SHIPPING"],"type":"string","title":"PickJobDeliveryInformationChannel","description":"PickJobDeliveryInformationChannel"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ExpectedPickLineItemForCreation":{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["transferId","quantity","article"],"title":"ExpectedPickLineItemForCreation","description":"ExpectedPickLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"PickJobPickingTimes":{"additionalProperties":false,"properties":{"startLatestAt":{"description":"The date this pickJob should be started at last.","format":"date-time","type":"string"}},"type":"object","title":"PickJobPickingTimes","description":"PickJobPickingTimes"},"PickLineItemForCreation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"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"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"PickLineItemForCreation","description":"PickLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickJobStatus":{"description":"The status of a pickjob.","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string","xml":{"name":"PickJobStatus"},"title":"PickJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The PickJobLineItemPartialStockLocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"}}}}
```

## The PickJobLineItemPartialStockLocationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"}}}}
```

## The PickJobLineItemPartialStockLocationForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"}}}}
```

## The PickJobMergeLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobMergeLineItemsActionEnum":{"enum":["MERGE_LINE_ITEMS_PICK_JOB"],"type":"string","title":"PickJobMergeLineItemsActionEnum","description":"PickJobMergeLineItemsActionEnum"}}}}
```

## The PickJobMergeLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobMergeLineItemsActionParameter":{"additionalProperties":false,"properties":{"lineItemIds":{"description":"Ids of the line items that should be merged","items":{"type":"string"},"type":"array"},"name":{"$ref":"#/components/schemas/PickJobMergeLineItemsActionEnum"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","lineItemIds"],"title":"PickJobMergeLineItemsActionParameter","type":"object","description":"PickJobMergeLineItemsActionParameter"},"PickJobMergeLineItemsActionEnum":{"enum":["MERGE_LINE_ITEMS_PICK_JOB"],"type":"string","title":"PickJobMergeLineItemsActionEnum","description":"PickJobMergeLineItemsActionEnum"}}}}
```

## The PickJobObsoleteActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobObsoleteActionEnum":{"enum":["OBSOLETE"],"type":"string","title":"PickJobObsoleteActionEnum","description":"PickJobObsoleteActionEnum"}}}}
```

## The PickJobObsoleteActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobObsoleteActionParameter":{"additionalProperties":false,"description":"Action to set the status to Obsolete of a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobObsoleteActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobObsoleteActionParameter","type":"object"},"PickJobObsoleteActionEnum":{"enum":["OBSOLETE"],"type":"string","title":"PickJobObsoleteActionEnum","description":"PickJobObsoleteActionEnum"}}}}
```

## The PickJobOrderBy object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobOrderBy":{"description":"Attribute to order a pickJobs by","enum":["TARGET_TIME_DESC","TARGET_TIME_ASC","LAST_MODIFIED_DESC","LAST_MODIFIED_ASC","ORDER_DATE_DESC","ORDER_DATE_ASC","LAST_MODIFIED_BY_USER_DESC","LAST_MODIFIED_BY_USER_ASC"],"type":"string","xml":{"name":"PickJobOrderBy"},"title":"PickJobOrderBy"}}}}
```

## The PickJobPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"pickJobs":{"items":{"$ref":"#/components/schemas/PickJob"},"type":"array"},"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","pickJobs"],"title":"PickJobPaginatedResult","type":"object","description":"PickJobPaginatedResult"},"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"},"PickJob":{"allOf":[{"$ref":"#/components/schemas/PickJobForCreation"},{"$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"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformation"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItem"},"type":"array"},"id":{"description":"The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"pickingZones":{"items":{"$ref":"#/components/schemas/PickingZone"},"type":"array"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItem"},"type":"array"},"pickRunRef":{"description":"Pick run id to which the pick job belongs","type":"string"},"resetBlocked":{"default":false,"description":"Indicates if pickJob can still be resetted or restarted","type":"boolean"},"shortId":{"description":"A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"statusReason":{"deprecated":true,"description":"deprecated: Use subStatus instead. Maintained for backward compatibility.","type":"string"},"subStatus":{"$ref":"#/components/schemas/PickJobSubStatus","description":"The reason for the current status."},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","status","pickLineItems","shortId","workflowInformation","deliveryinformation","documentsRef"],"type":"object"}],"title":"PickJob","description":"PickJob"},"PickJobForCreation":{"additionalProperties":false,"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},"minItems":0,"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order reference. The given ID has to be present in the system.","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickingTimes":{"$ref":"#/components/schemas/PickJobPickingTimes"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItemForCreation"},"minItems":0,"type":"array"},"preferredPickingMethods":{"description":"Preferred way of picking a given pickJob.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"routingPlanRef":{"description":"Reference to the routingplan which created this pickjob","type":"string"},"shortId":{"description":"A short identifier that helps assigning a pick job to a customer.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"minItems":0,"type":"array"},"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"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"description":"Tags can only be set when there is no process related with this pickJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["orderDate","facilityRef","pickLineItems"],"type":"object","xml":{"name":"Pickjob"},"title":"PickJobForCreation","description":"PickJobForCreation"},"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"},"PickjobDeliveryInformationForCreation":{"properties":{"channel":{"$ref":"#/components/schemas/PickJobDeliveryInformationChannel"},"details":{"properties":{"collect":{"properties":{"identifier":{"description":"Includes information about Click & Collect recipient","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"}},"type":"object"},"shipping":{"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label, this is specific to a carrier","type":"string"},"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"identifier":{"description":"Includes information on how to identify Ship from Store recipient (Name, PIN, Reference number, ...)","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientaddress":{"$ref":"#/components/schemas/ConsumerAddress"},"serviceLevel":{"description":"TBD","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object"}},"type":"object"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"}},"type":"object","title":"PickjobDeliveryInformationForCreation","description":"PickjobDeliveryInformationForCreation"},"PickJobDeliveryInformationChannel":{"enum":["COLLECT","SHIPPING"],"type":"string","title":"PickJobDeliveryInformationChannel","description":"PickJobDeliveryInformationChannel"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ExpectedPickLineItemForCreation":{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["transferId","quantity","article"],"title":"ExpectedPickLineItemForCreation","description":"ExpectedPickLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"PickJobPickingTimes":{"additionalProperties":false,"properties":{"startLatestAt":{"description":"The date this pickJob should be started at last.","format":"date-time","type":"string"}},"type":"object","title":"PickJobPickingTimes","description":"PickJobPickingTimes"},"PickLineItemForCreation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"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"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"PickLineItemForCreation","description":"PickLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickJobStatus":{"description":"The status of a pickjob.","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string","xml":{"name":"PickJobStatus"},"title":"PickJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"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"},"PickjobDeliveryInformation":{"allOf":[{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},{"required":["channel"]}],"type":"object","title":"PickjobDeliveryInformation","description":"PickjobDeliveryInformation"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ExpectedPickLineItem":{"allOf":[{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["id"],"type":"object"}],"title":"ExpectedPickLineItem","description":"ExpectedPickLineItem"},"PickingZone":{"description":"Zones from which items can be picked","properties":{"zoneRef":{"type":"string"}},"required":["zoneRef"],"type":"object","title":"PickingZone"},"PickLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. 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":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"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"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickLineItem","description":"PickLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"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"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"PickJobSubStatus":{"description":"The reason for the current status, providing type-safe context beyond the status field.","enum":["SHORT_PICKED","ZERO_PICKED","WAITING_FOR_RELEASE_TIME","ORDER_MODIFIED","PROCESS_REROUTE","MANUAL_REROUTE","SHORT_PICK_REROUTE","TIME_TRIGGERED","STOCK_ZEROED","PICK_JOB_ABORTED","RECALCULATION"],"type":"string","xml":{"name":"PickJobSubStatus"},"title":"PickJobSubStatus"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"}}}}
```

## The PickJobPauseActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobPauseActionEnum":{"enum":["PAUSE"],"type":"string","title":"PickJobPauseActionEnum","description":"PickJobPauseActionEnum"}}}}
```

## The PickJobPauseActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobPauseActionParameter":{"additionalProperties":false,"description":"Action to pause a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobPauseActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobPauseActionParameter","type":"object"},"PickJobPauseActionEnum":{"enum":["PAUSE"],"type":"string","title":"PickJobPauseActionEnum","description":"PickJobPauseActionEnum"}}}}
```

## The PickJobPickedActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobPickedActionEnum":{"enum":["PICK"],"type":"string","title":"PickJobPickedActionEnum","description":"PickJobPickedActionEnum"}}}}
```

## The PickJobPickedActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobPickedActionParameter":{"additionalProperties":false,"description":"Action to set the status to Picked of a Pickjob.","properties":{"lineItems":{"description":"Pick line items that should be updated ","items":{"$ref":"#/components/schemas/PickPickJobPickLineItemUpdate"},"maxItems":100,"minItems":1,"type":"array"},"name":{"$ref":"#/components/schemas/PickJobPickedActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","lineItems"],"title":"PickJobPickedActionParameter","type":"object"},"PickPickJobPickLineItemUpdate":{"additionalProperties":false,"properties":{"customAttributes":{"description":"Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"},"maxItems":50,"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked. example: '2024-02-03T08:45:51.525Z' format: date-time type: string"},"scannedCodes":{"description":"Scanned Codes of the given picked line item","items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"maxItems":50,"minItems":0,"type":"array"},"secondaryPicked":{"type":"integer"},"shortPickReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}}},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItemForUpsert"},"maxItems":50,"type":"array"}},"required":["id"],"type":"object","title":"PickPickJobPickLineItemUpdate","description":"PickPickJobPickLineItemUpdate"},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItemForUpsert":{"properties":{"id":{"description":"The id of the substitute line item to update. If none is passed, a new substitute line item will be created.","type":"string"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"tenantArticleId":{"description":"TenantArticleId of the substitute article","type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"SubstituteLineItemForUpsert","description":"SubstituteLineItemForUpsert"},"PickJobPickedActionEnum":{"enum":["PICK"],"type":"string","title":"PickJobPickedActionEnum","description":"PickJobPickedActionEnum"}}}}
```

## The PickJobPickingMethodEnumEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobPickingMethodEnumEnumFilter":{"properties":{"eq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"in":{"description":"Search by preferredPickingMethods","items":{"enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"}},"title":"PickJobPickingMethodEnumEnumFilter","type":"object","description":"PickJobPickingMethodEnumEnumFilter"}}}}
```

## The PickJobPickingMethodEnumEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobPickingMethodEnumEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PickJobPickingMethodEnumEnumFilter"}],"description":"Search by preferredPickingMethods"}},"title":"PickJobPickingMethodEnumEnumListFilter","type":"object","description":"PickJobPickingMethodEnumEnumListFilter"},"PickJobPickingMethodEnumEnumFilter":{"properties":{"eq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"in":{"description":"Search by preferredPickingMethods","items":{"enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"}},"title":"PickJobPickingMethodEnumEnumFilter","type":"object","description":"PickJobPickingMethodEnumEnumFilter"}}}}
```

## The PickJobPickingTimes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobPickingTimes":{"additionalProperties":false,"properties":{"startLatestAt":{"description":"The date this pickJob should be started at last.","format":"date-time","type":"string"}},"type":"object","title":"PickJobPickingTimes","description":"PickJobPickingTimes"}}}}
```

## The PickjobPickLinePickedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickjobPickLinePickedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/PickLineItem"},"pickJobRef":{"type":"string"}},"required":["payload","pickJobRef"],"type":"object","title":"PickjobPickLinePickedWebHookEvent","description":"PickjobPickLinePickedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"PickLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. 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":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"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"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickLineItem","description":"PickLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The PickJobReplaceAssignedUsersActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"PickJobReplaceAssignedUsersActionEnum","description":"PickJobReplaceAssignedUsersActionEnum"}}}}
```

## The PickJobReplaceAssignedUsersActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobReplaceAssignedUsersActionParameter":{"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/PickJobReplaceAssignedUsersActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","assignedUsers"],"title":"PickJobReplaceAssignedUsersActionParameter"},"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"},"PickJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"PickJobReplaceAssignedUsersActionEnum","description":"PickJobReplaceAssignedUsersActionEnum"}}}}
```

## The PickJobResetActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobResetActionEnum":{"enum":["RESET"],"type":"string","title":"PickJobResetActionEnum","description":"PickJobResetActionEnum"}}}}
```

## The PickJobResetActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobResetActionParameter":{"additionalProperties":false,"description":"Action to reset a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobResetActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobResetActionParameter","type":"object"},"PickJobResetActionEnum":{"enum":["RESET"],"type":"string","title":"PickJobResetActionEnum","description":"PickJobResetActionEnum"}}}}
```

## The PickJobRestartActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobRestartActionEnum":{"enum":["RESTART"],"type":"string","title":"PickJobRestartActionEnum","description":"PickJobRestartActionEnum"}}}}
```

## The PickJobRestartActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobRestartActionParameter":{"additionalProperties":false,"description":"Action to Restart a Pickjob.","properties":{"name":{"$ref":"#/components/schemas/PickJobRestartActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobRestartActionParameter","type":"object"},"PickJobRestartActionEnum":{"enum":["RESTART"],"type":"string","title":"PickJobRestartActionEnum","description":"PickJobRestartActionEnum"}}}}
```

## The PickJobSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobSearchPayload":{"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/PickJobSearchQuery"},"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/PickJobSort"},"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":"PickJobSearchPayload","type":"object","description":"PickJobSearchPayload"},"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"},"PickJobSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/PickJobSearchQuery"},"maxItems":500,"type":"array"},"consumerName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerName"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/PickJobSearchQuery"},"maxItems":500,"type":"array"},"orderRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by orderRef"},"preferredPickingMethods":{"allOf":[{"$ref":"#/components/schemas/PickJobPickingMethodEnumEnumListFilter"}],"description":"Search by preferredPickingMethods"},"status":{"allOf":[{"$ref":"#/components/schemas/PickJobStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantArticleIds":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by tenantArticleIds"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"},"transfers":{"allOf":[{"$ref":"#/components/schemas/PickJobTransfersListFilter"}],"description":"Nested list search by transfers"}},"title":"PickJobSearchQuery","type":"object","description":"PickJobSearchQuery"},"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"},"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"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"PickJobPickingMethodEnumEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PickJobPickingMethodEnumEnumFilter"}],"description":"Search by preferredPickingMethods"}},"title":"PickJobPickingMethodEnumEnumListFilter","type":"object","description":"PickJobPickingMethodEnumEnumListFilter"},"PickJobPickingMethodEnumEnumFilter":{"properties":{"eq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"in":{"description":"Search by preferredPickingMethods","items":{"enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"}},"title":"PickJobPickingMethodEnumEnumFilter","type":"object","description":"PickJobPickingMethodEnumEnumFilter"},"PickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"PickJobStatusEnumFilter","type":"object","description":"PickJobStatusEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"PickJobTransfersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PickJobTransfersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PickJobTransfersListFilter","type":"object","description":"PickJobTransfersListFilter"},"PickJobTransfersFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by id"}},"title":"PickJobTransfersFilter","type":"object","description":"PickJobTransfersFilter"},"PickJobSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"},"tenantOrderId":{"enum":["ASC","DESC"],"type":"string"}},"title":"PickJobSort","type":"object","description":"PickJobSort"}}}}
```

## The PickJobSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/PickJobSearchQuery"},"maxItems":500,"type":"array"},"consumerName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerName"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/PickJobSearchQuery"},"maxItems":500,"type":"array"},"orderRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by orderRef"},"preferredPickingMethods":{"allOf":[{"$ref":"#/components/schemas/PickJobPickingMethodEnumEnumListFilter"}],"description":"Search by preferredPickingMethods"},"status":{"allOf":[{"$ref":"#/components/schemas/PickJobStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantArticleIds":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by tenantArticleIds"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"},"transfers":{"allOf":[{"$ref":"#/components/schemas/PickJobTransfersListFilter"}],"description":"Nested list search by transfers"}},"title":"PickJobSearchQuery","type":"object","description":"PickJobSearchQuery"},"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"},"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"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"PickJobPickingMethodEnumEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PickJobPickingMethodEnumEnumFilter"}],"description":"Search by preferredPickingMethods"}},"title":"PickJobPickingMethodEnumEnumListFilter","type":"object","description":"PickJobPickingMethodEnumEnumListFilter"},"PickJobPickingMethodEnumEnumFilter":{"properties":{"eq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"in":{"description":"Search by preferredPickingMethods","items":{"enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"}},"title":"PickJobPickingMethodEnumEnumFilter","type":"object","description":"PickJobPickingMethodEnumEnumFilter"},"PickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"PickJobStatusEnumFilter","type":"object","description":"PickJobStatusEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"PickJobTransfersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PickJobTransfersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PickJobTransfersListFilter","type":"object","description":"PickJobTransfersListFilter"},"PickJobTransfersFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by id"}},"title":"PickJobTransfersFilter","type":"object","description":"PickJobTransfersFilter"}}}}
```

## The PickJobSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"},"tenantOrderId":{"enum":["ASC","DESC"],"type":"string"}},"title":"PickJobSort","type":"object","description":"PickJobSort"}}}}
```

## The PickJobSplitLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINE_ITEMS_PICK_JOB"],"type":"string","title":"PickJobSplitLineItemsActionEnum","description":"PickJobSplitLineItemsActionEnum"}}}}
```

## The PickJobSplitLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/PickJobSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/PickJobSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"PickJobSplitLineItemsActionParameter","type":"object","description":"PickJobSplitLineItemsActionParameter"},"PickJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINE_ITEMS_PICK_JOB"],"type":"string","title":"PickJobSplitLineItemsActionEnum","description":"PickJobSplitLineItemsActionEnum"},"PickJobSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the pickLineItem of a pickJob","type":"string"},"picked":{"description":"The amount of articles that were picked for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity","picked"],"type":"object","title":"PickJobSplitLineItemsInfo","description":"PickJobSplitLineItemsInfo"}}}}
```

## The PickJobSplitLineItemsInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the pickLineItem of a pickJob","type":"string"},"picked":{"description":"The amount of articles that were picked for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity","picked"],"type":"object","title":"PickJobSplitLineItemsInfo","description":"PickJobSplitLineItemsInfo"}}}}
```

## The PickJobStartActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobStartActionEnum":{"enum":["START"],"type":"string","title":"PickJobStartActionEnum","description":"PickJobStartActionEnum"}}}}
```

## The PickJobStartActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobStartActionParameter":{"additionalProperties":false,"description":"Action to start a PickJob by setting it and its line items to IN_PROGRESS.","properties":{"name":{"$ref":"#/components/schemas/PickJobStartActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickJobStartActionParameter","type":"object"},"PickJobStartActionEnum":{"enum":["START"],"type":"string","title":"PickJobStartActionEnum","description":"PickJobStartActionEnum"}}}}
```

## The PickJobStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobStatus":{"description":"The status of a pickjob.","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string","xml":{"name":"PickJobStatus"},"title":"PickJobStatus"}}}}
```

## The PickJobStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"PickJobStatusEnumFilter","type":"object","description":"PickJobStatusEnumFilter"}}}}
```

## The PickJobStatusUnprotected object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobStatusUnprotected":{"description":"The status of a pickjob. These are the status that are still allowed to be used in the deprecated status field of ModifyPickJob actions","enum":["OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","PAUSED","WAITING_FOR_INPUT"],"type":"string","xml":{"name":"PickJobStatusUnprotected"},"title":"PickJobStatusUnprotected"}}}}
```

## The PickJobSubStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobSubStatus":{"description":"The reason for the current status, providing type-safe context beyond the status field.","enum":["SHORT_PICKED","ZERO_PICKED","WAITING_FOR_RELEASE_TIME","ORDER_MODIFIED","PROCESS_REROUTE","MANUAL_REROUTE","SHORT_PICK_REROUTE","TIME_TRIGGERED","STOCK_ZEROED","PICK_JOB_ABORTED","RECALCULATION"],"type":"string","xml":{"name":"PickJobSubStatus"},"title":"PickJobSubStatus"}}}}
```

## The PickJobTagConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"lineItemScanningConfiguration":{"$ref":"#/components/schemas/TagScanningConfiguration"},"lineItemStickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"},"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"type":"array"},"preferredPickingMethodsConfiguration":{"$ref":"#/components/schemas/PreferredPickingMethodsConfiguration"},"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"PickJobTagConfiguration","description":"PickJobTagConfiguration"},"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"},"TagScanningConfiguration":{"additionalProperties":false,"properties":{"offeredScanningRuleByTag":{"items":{"$ref":"#/components/schemas/OfferedScanningRuleByTag"},"type":"array"}},"title":"TagScanningConfiguration","description":"TagScanningConfiguration"},"OfferedScanningRuleByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"scanningType":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"tagRef":{"minLength":1,"type":"string"}},"required":["tagRef","matchingValues","scanningType"],"type":"object","title":"OfferedScanningRuleByTag","description":"OfferedScanningRuleByTag"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"PreferredPickingMethodsConfiguration":{"properties":{"PreferredPickingMethodsPerTag":{"items":{"$ref":"#/components/schemas/PreferredPickingMethodsPerTag"},"type":"array"}},"title":"PreferredPickingMethodsConfiguration","description":"PreferredPickingMethodsConfiguration"},"PreferredPickingMethodsPerTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"pickingMethods":{"items":{"$ref":"#/components/schemas/PickingMethodEnum"},"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","pickingMethods","matchingValues"],"title":"PreferredPickingMethodsPerTag","description":"PreferredPickingMethodsPerTag"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"}}}}
```

## The PickJobTransfersFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobTransfersFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by id"}},"title":"PickJobTransfersFilter","type":"object","description":"PickJobTransfersFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The PickJobTransfersListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickJobTransfersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PickJobTransfersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PickJobTransfersListFilter","type":"object","description":"PickJobTransfersListFilter"},"PickJobTransfersFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by id"}},"title":"PickJobTransfersFilter","type":"object","description":"PickJobTransfersFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The PickjobWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickjobWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/PickJob"}},"required":["payload"],"type":"object","title":"PickjobWebHookEvent","description":"PickjobWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"PickJob":{"allOf":[{"$ref":"#/components/schemas/PickJobForCreation"},{"$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"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformation"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItem"},"type":"array"},"id":{"description":"The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"pickingZones":{"items":{"$ref":"#/components/schemas/PickingZone"},"type":"array"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItem"},"type":"array"},"pickRunRef":{"description":"Pick run id to which the pick job belongs","type":"string"},"resetBlocked":{"default":false,"description":"Indicates if pickJob can still be resetted or restarted","type":"boolean"},"shortId":{"description":"A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"statusReason":{"deprecated":true,"description":"deprecated: Use subStatus instead. Maintained for backward compatibility.","type":"string"},"subStatus":{"$ref":"#/components/schemas/PickJobSubStatus","description":"The reason for the current status."},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","status","pickLineItems","shortId","workflowInformation","deliveryinformation","documentsRef"],"type":"object"}],"title":"PickJob","description":"PickJob"},"PickJobForCreation":{"additionalProperties":false,"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},"minItems":0,"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order reference. The given ID has to be present in the system.","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickingTimes":{"$ref":"#/components/schemas/PickJobPickingTimes"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItemForCreation"},"minItems":0,"type":"array"},"preferredPickingMethods":{"description":"Preferred way of picking a given pickJob.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"routingPlanRef":{"description":"Reference to the routingplan which created this pickjob","type":"string"},"shortId":{"description":"A short identifier that helps assigning a pick job to a customer.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"minItems":0,"type":"array"},"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"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"description":"Tags can only be set when there is no process related with this pickJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["orderDate","facilityRef","pickLineItems"],"type":"object","xml":{"name":"Pickjob"},"title":"PickJobForCreation","description":"PickJobForCreation"},"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"},"PickjobDeliveryInformationForCreation":{"properties":{"channel":{"$ref":"#/components/schemas/PickJobDeliveryInformationChannel"},"details":{"properties":{"collect":{"properties":{"identifier":{"description":"Includes information about Click & Collect recipient","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"}},"type":"object"},"shipping":{"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label, this is specific to a carrier","type":"string"},"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"identifier":{"description":"Includes information on how to identify Ship from Store recipient (Name, PIN, Reference number, ...)","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientaddress":{"$ref":"#/components/schemas/ConsumerAddress"},"serviceLevel":{"description":"TBD","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object"}},"type":"object"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"}},"type":"object","title":"PickjobDeliveryInformationForCreation","description":"PickjobDeliveryInformationForCreation"},"PickJobDeliveryInformationChannel":{"enum":["COLLECT","SHIPPING"],"type":"string","title":"PickJobDeliveryInformationChannel","description":"PickJobDeliveryInformationChannel"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ExpectedPickLineItemForCreation":{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["transferId","quantity","article"],"title":"ExpectedPickLineItemForCreation","description":"ExpectedPickLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"PickJobPickingTimes":{"additionalProperties":false,"properties":{"startLatestAt":{"description":"The date this pickJob should be started at last.","format":"date-time","type":"string"}},"type":"object","title":"PickJobPickingTimes","description":"PickJobPickingTimes"},"PickLineItemForCreation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"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"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"PickLineItemForCreation","description":"PickLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickJobStatus":{"description":"The status of a pickjob.","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string","xml":{"name":"PickJobStatus"},"title":"PickJobStatus"},"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"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"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"},"PickjobDeliveryInformation":{"allOf":[{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},{"required":["channel"]}],"type":"object","title":"PickjobDeliveryInformation","description":"PickjobDeliveryInformation"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ExpectedPickLineItem":{"allOf":[{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["id"],"type":"object"}],"title":"ExpectedPickLineItem","description":"ExpectedPickLineItem"},"PickingZone":{"description":"Zones from which items can be picked","properties":{"zoneRef":{"type":"string"}},"required":["zoneRef"],"type":"object","title":"PickingZone"},"PickLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. 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":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"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"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickLineItem","description":"PickLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"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"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"PickJobSubStatus":{"description":"The reason for the current status, providing type-safe context beyond the status field.","enum":["SHORT_PICKED","ZERO_PICKED","WAITING_FOR_RELEASE_TIME","ORDER_MODIFIED","PROCESS_REROUTE","MANUAL_REROUTE","SHORT_PICK_REROUTE","TIME_TRIGGERED","STOCK_ZEROED","PICK_JOB_ABORTED","RECALCULATION"],"type":"string","xml":{"name":"PickJobSubStatus"},"title":"PickJobSubStatus"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"}}}}
```

## The PickLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. 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":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"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"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickLineItem","description":"PickLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The PickLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The PickLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickLineItemForCreation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"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"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"PickLineItemForCreation","description":"PickLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PickLineItemScannedCode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"}}}}
```

## The PickLineItemScanningRules object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"}}}}
```

## The PickLineItemStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"}}}}
```

## The PickLineItemUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickLineItemUpdate":{"additionalProperties":false,"properties":{"customAttributes":{"description":"Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"},"maxItems":50,"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"scannedCodes":{"description":"Scanned Codes of the given picked line item","items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"maxItems":50,"minItems":0,"type":"array"},"secondaryPicked":{"type":"integer"},"shortPickReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}}},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItemForUpsert"},"maxItems":50,"type":"array"}},"required":["id"],"type":"object","title":"PickLineItemUpdate","description":"PickLineItemUpdate"},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItemForUpsert":{"properties":{"id":{"description":"The id of the substitute line item to update. If none is passed, a new substitute line item will be created.","type":"string"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"tenantArticleId":{"description":"TenantArticleId of the substitute article","type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"SubstituteLineItemForUpsert","description":"SubstituteLineItemForUpsert"}}}}
```

## The PickLineShortPickReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The PickPickJobPickLineItemUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickPickJobPickLineItemUpdate":{"additionalProperties":false,"properties":{"customAttributes":{"description":"Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"},"maxItems":50,"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked. example: '2024-02-03T08:45:51.525Z' format: date-time type: string"},"scannedCodes":{"description":"Scanned Codes of the given picked line item","items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"maxItems":50,"minItems":0,"type":"array"},"secondaryPicked":{"type":"integer"},"shortPickReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}}},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItemForUpsert"},"maxItems":50,"type":"array"}},"required":["id"],"type":"object","title":"PickPickJobPickLineItemUpdate","description":"PickPickJobPickLineItemUpdate"},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItemForUpsert":{"properties":{"id":{"description":"The id of the substitute line item to update. If none is passed, a new substitute line item will be created.","type":"string"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"tenantArticleId":{"description":"TenantArticleId of the substitute article","type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"SubstituteLineItemForUpsert","description":"SubstituteLineItemForUpsert"}}}}
```

## The PickRun object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRun":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"type":"string"},"id":{"type":"string"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickRunLineItem"},"type":"array"},"pickRunType":{"$ref":"#/components/schemas/PickRunType"},"status":{"$ref":"#/components/schemas/PickRunStatus"}}}],"required":["pickLineItems","pickJobRefs","facilityRef","status","id"],"type":"object","title":"PickRun","description":"PickRun"},"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"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"PickRunLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemIds":{"items":{"description":"Global line item ids that refer to this line item","type":"string"},"type":"array"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"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"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"pickJobRef":{"type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickRunLineItem","description":"PickRunLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PickRunType":{"default":"batchPick","description":"Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead","enum":["multiOrderPick","multiOrder","batchPick","batch"],"type":"string","title":"PickRunType"},"PickRunStatus":{"description":"The state of the PickRun","enum":["OPEN","IN_PROGRESS","CLOSED","PAUSED","CANCELED","OBSOLETE"],"type":"string","title":"PickRunStatus"}}}}
```

## The PickRunActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/PickRunStartActionParameter"},{"$ref":"#/components/schemas/PickRunFinishActionParameter"},{"$ref":"#/components/schemas/PickRunCancelActionParameter"},{"$ref":"#/components/schemas/PickRunPauseActionParameter"},{"$ref":"#/components/schemas/PickRunResumeActionParameter"},{"$ref":"#/components/schemas/PickRunRemovePickJobActionParameter"},{"$ref":"#/components/schemas/PickRunSplitLineItemsActionParameter"},{"$ref":"#/components/schemas/TakeOverPickRunActionParameter"}],"title":"PickRunActionsParameter","description":"PickRunActionsParameter"},"PickRunStartActionParameter":{"additionalProperties":false,"description":"Action to start a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunStartActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunStartActionParameter","type":"object"},"PickRunStartActionEnum":{"enum":["START"],"type":"string","title":"PickRunStartActionEnum","description":"PickRunStartActionEnum"},"PickRunFinishActionParameter":{"additionalProperties":false,"description":"Action to finish a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunFinishActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunFinishActionParameter","type":"object"},"PickRunFinishActionEnum":{"enum":["FINISH"],"type":"string","title":"PickRunFinishActionEnum","description":"PickRunFinishActionEnum"},"PickRunCancelActionParameter":{"additionalProperties":false,"description":"Action to cancel a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunCancelActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunCancelActionParameter","type":"object"},"PickRunCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"PickRunCancelActionEnum","description":"PickRunCancelActionEnum"},"PickRunPauseActionParameter":{"additionalProperties":false,"description":"Action to pause a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunPauseActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunPauseActionParameter","type":"object"},"PickRunPauseActionEnum":{"enum":["PAUSE"],"type":"string","title":"PickRunPauseActionEnum","description":"PickRunPauseActionEnum"},"PickRunResumeActionParameter":{"additionalProperties":false,"description":"Action to resume a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunResumeActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunResumeActionParameter","type":"object"},"PickRunResumeActionEnum":{"enum":["RESUME"],"type":"string","title":"PickRunResumeActionEnum","description":"PickRunResumeActionEnum"},"PickRunRemovePickJobActionParameter":{"additionalProperties":false,"description":"Action to Remove a Pickjob from a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunRemovePickJobActionEnum"},"payload":{"additionalProperties":false,"properties":{"pickJobId":{"type":"string"}},"required":["pickJobId"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","payload"],"title":"PickRunRemovePickJobActionParameter","type":"object"},"PickRunRemovePickJobActionEnum":{"enum":["REMOVE_PICK_JOB"],"type":"string","title":"PickRunRemovePickJobActionEnum","description":"PickRunRemovePickJobActionEnum"},"PickRunSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/PickRunSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/PickRunSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"PickRunSplitLineItemsActionParameter","type":"object","description":"PickRunSplitLineItemsActionParameter"},"PickRunSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_PICK_RUN"],"type":"string","title":"PickRunSplitLineItemsActionEnum","description":"PickRunSplitLineItemsActionEnum"},"PickRunSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the pickLineItem of a pickRun","type":"string"},"picked":{"description":"The amount of articles that were picked for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity","picked"],"type":"object","title":"PickRunSplitLineItemsInfo","description":"PickRunSplitLineItemsInfo"},"TakeOverPickRunActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/TakeOverPickRunActionEnum"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version"],"title":"TakeOverPickRunActionParameter","type":"object","description":"TakeOverPickRunActionParameter"},"TakeOverPickRunActionEnum":{"enum":["TAKE_OVER_PICK_RUN"],"type":"string","title":"TakeOverPickRunActionEnum","description":"TakeOverPickRunActionEnum"}}}}
```

## The PickRunCancelActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"PickRunCancelActionEnum","description":"PickRunCancelActionEnum"}}}}
```

## The PickRunCancelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunCancelActionParameter":{"additionalProperties":false,"description":"Action to cancel a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunCancelActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunCancelActionParameter","type":"object"},"PickRunCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"PickRunCancelActionEnum","description":"PickRunCancelActionEnum"}}}}
```

## The PickRunFinishActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunFinishActionEnum":{"enum":["FINISH"],"type":"string","title":"PickRunFinishActionEnum","description":"PickRunFinishActionEnum"}}}}
```

## The PickRunFinishActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunFinishActionParameter":{"additionalProperties":false,"description":"Action to finish a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunFinishActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunFinishActionParameter","type":"object"},"PickRunFinishActionEnum":{"enum":["FINISH"],"type":"string","title":"PickRunFinishActionEnum","description":"PickRunFinishActionEnum"}}}}
```

## The PickRunForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunForCreation":{"properties":{"facilityRef":{"type":"string"},"pickJobRefs":{"items":{"type":"string"},"minItems":1,"type":"array"},"pickRunType":{"$ref":"#/components/schemas/PickRunType"},"status":{"$ref":"#/components/schemas/PickRunStatus"}},"required":["pickJobRefs","facilityRef"],"type":"object","title":"PickRunForCreation","description":"PickRunForCreation"},"PickRunType":{"default":"batchPick","description":"Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead","enum":["multiOrderPick","multiOrder","batchPick","batch"],"type":"string","title":"PickRunType"},"PickRunStatus":{"description":"The state of the PickRun","enum":["OPEN","IN_PROGRESS","CLOSED","PAUSED","CANCELED","OBSOLETE"],"type":"string","title":"PickRunStatus"}}}}
```

## The PickRunLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemIds":{"items":{"description":"Global line item ids that refer to this line item","type":"string"},"type":"array"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"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"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"pickJobRef":{"type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickRunLineItem","description":"PickRunLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The PickRunLineItems object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunLineItems":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemIds":{"items":{"description":"Global line item ids that refer to this line item","type":"string"},"type":"array"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"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"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"pickJobRef":{"type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickRunLineItems","description":"PickRunLineItems"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","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"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"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"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The PickRunPatchAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunPatchAction":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyPickRunLineItem"},{"$ref":"#/components/schemas/StartPickRun"},{"$ref":"#/components/schemas/CancelPickRun"},{"$ref":"#/components/schemas/FinishPickRun"}]},"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":"PickRunPatchAction"},"title":"PickRunPatchAction","description":"PickRunPatchAction"},"ModifyPickRunLineItem":{"allOf":[{"properties":{"action":{"description":"Use value 'ModifyPickRunLineItem', because you want to modify a pick line item","enum":["ModifyPickRunLineItem"],"type":"string"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForUpdate"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/ShortPickReasonForUpsert"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"}},"required":["id","action"],"type":"object"}],"description":"Action to modify a lineitem of a pickrun","title":"ModifyPickRunLineItem","xml":{"name":"ModifyPickRunLineItem"}},"PickJobLineItemPartialStockLocationForUpdate":{"properties":{"picked":{"format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","picked"],"type":"object","title":"PickJobLineItemPartialStockLocationForUpdate","description":"PickJobLineItemPartialStockLocationForUpdate"},"ShortPickReasonForUpsert":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object","title":"ShortPickReasonForUpsert","description":"ShortPickReasonForUpsert"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"StartPickRun":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'StartPickRun', because you want to start a pickrun","enum":["StartPickRun"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickruns/:id/actions instead","title":"StartPickRun","xml":{"name":"StartPickRun"}},"CancelPickRun":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'CancelPickRun', because you want to cancel a pickrun","enum":["CancelPickRun"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickruns/:id/actions instead","title":"CancelPickRun","xml":{"name":"CancelPickRun"}},"FinishPickRun":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'FinishPickRun', because you want to finish a pickrun","enum":["FinishPickRun"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickruns/:id/actions instead","title":"FinishPickRun","xml":{"name":"FinishPickRun"}}}}}
```

## The PickRunPauseActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunPauseActionEnum":{"enum":["PAUSE"],"type":"string","title":"PickRunPauseActionEnum","description":"PickRunPauseActionEnum"}}}}
```

## The PickRunPauseActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunPauseActionParameter":{"additionalProperties":false,"description":"Action to pause a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunPauseActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunPauseActionParameter","type":"object"},"PickRunPauseActionEnum":{"enum":["PAUSE"],"type":"string","title":"PickRunPauseActionEnum","description":"PickRunPauseActionEnum"}}}}
```

## The PickRunPickJobsPatchAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunPickJobsPatchAction":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/RemovePickJobFromPickRun"}]},"maxItems":1,"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":"PickRunPickJobsPatchAction"},"title":"PickRunPickJobsPatchAction","description":"PickRunPickJobsPatchAction"},"RemovePickJobFromPickRun":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'RemovePickJobFromPickRun', because you want to remove a pickjob","enum":["RemovePickJobFromPickRun"],"type":"string"},"pickJobRef":{"description":"PickJob reference of the PickJob you want to remove.","type":"string"}},"required":["action","pickJobRef"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use /api/pickruns/{pickRunId}/actions instead","title":"RemovePickJobFromPickRun","xml":{"name":"RemovePickJobFromPickRun"}}}}}
```

## The PickRunRemovePickJobActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunRemovePickJobActionEnum":{"enum":["REMOVE_PICK_JOB"],"type":"string","title":"PickRunRemovePickJobActionEnum","description":"PickRunRemovePickJobActionEnum"}}}}
```

## The PickRunRemovePickJobActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunRemovePickJobActionParameter":{"additionalProperties":false,"description":"Action to Remove a Pickjob from a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunRemovePickJobActionEnum"},"payload":{"additionalProperties":false,"properties":{"pickJobId":{"type":"string"}},"required":["pickJobId"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","payload"],"title":"PickRunRemovePickJobActionParameter","type":"object"},"PickRunRemovePickJobActionEnum":{"enum":["REMOVE_PICK_JOB"],"type":"string","title":"PickRunRemovePickJobActionEnum","description":"PickRunRemovePickJobActionEnum"}}}}
```

## The PickRunResumeActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunResumeActionEnum":{"enum":["RESUME"],"type":"string","title":"PickRunResumeActionEnum","description":"PickRunResumeActionEnum"}}}}
```

## The PickRunResumeActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunResumeActionParameter":{"additionalProperties":false,"description":"Action to resume a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunResumeActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunResumeActionParameter","type":"object"},"PickRunResumeActionEnum":{"enum":["RESUME"],"type":"string","title":"PickRunResumeActionEnum","description":"PickRunResumeActionEnum"}}}}
```

## The PickRunSplitLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_PICK_RUN"],"type":"string","title":"PickRunSplitLineItemsActionEnum","description":"PickRunSplitLineItemsActionEnum"}}}}
```

## The PickRunSplitLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/PickRunSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/PickRunSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"PickRunSplitLineItemsActionParameter","type":"object","description":"PickRunSplitLineItemsActionParameter"},"PickRunSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_PICK_RUN"],"type":"string","title":"PickRunSplitLineItemsActionEnum","description":"PickRunSplitLineItemsActionEnum"},"PickRunSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the pickLineItem of a pickRun","type":"string"},"picked":{"description":"The amount of articles that were picked for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity","picked"],"type":"object","title":"PickRunSplitLineItemsInfo","description":"PickRunSplitLineItemsInfo"}}}}
```

## The PickRunSplitLineItemsInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the pickLineItem of a pickRun","type":"string"},"picked":{"description":"The amount of articles that were picked for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity","picked"],"type":"object","title":"PickRunSplitLineItemsInfo","description":"PickRunSplitLineItemsInfo"}}}}
```

## The PickRunStartActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunStartActionEnum":{"enum":["START"],"type":"string","title":"PickRunStartActionEnum","description":"PickRunStartActionEnum"}}}}
```

## The PickRunStartActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunStartActionParameter":{"additionalProperties":false,"description":"Action to start a PickRun.","properties":{"name":{"$ref":"#/components/schemas/PickRunStartActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"PickRunStartActionParameter","type":"object"},"PickRunStartActionEnum":{"enum":["START"],"type":"string","title":"PickRunStartActionEnum","description":"PickRunStartActionEnum"}}}}
```

## The PickRunStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunStatus":{"description":"The state of the PickRun","enum":["OPEN","IN_PROGRESS","CLOSED","PAUSED","CANCELED","OBSOLETE"],"type":"string","title":"PickRunStatus"}}}}
```

## The PickRunType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickRunType":{"default":"batchPick","description":"Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead","enum":["multiOrderPick","multiOrder","batchPick","batch"],"type":"string","title":"PickRunType"}}}}
```

## The PickupService object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickupService":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name of this pickupService"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this pickupService"},"active":{"description":"Whether this pickupService is active","type":"boolean"},"context":{"description":"The contexts in which this pickupService is available","items":{"$ref":"#/components/schemas/PickupServiceContext"},"type":"array"},"created":{"description":"Creation date of this pickupService","format":"date-time","type":"string"},"description":{"description":"Description of this pickupService, derived from descriptionLocalized for the requested locale","type":"string"},"id":{"description":"Unique identifier of this pickupService","type":"string"},"lastModified":{"description":"Last modification date of this pickupService","format":"date-time","type":"string"},"name":{"description":"Name of this pickupService, derived from nameLocalized for the requested locale","type":"string"},"type":{"description":"Type of this pickupService","enum":["ID_CHECK","SIGNATURE"],"type":"string"},"version":{"description":"Version number of this pickupService","type":"number"}},"required":["id","version","created","lastModified","type","descriptionLocalized","nameLocalized","active","context"],"title":"PickupService","type":"object","description":"PickupService"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickupServiceContext":{"properties":{"type":{"description":"Type of this pickupService context","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"values":{"description":"Values of this pickupService context","items":{"type":"string"},"type":"array"}},"required":["type","values"],"title":"PickupServiceContext","type":"object","description":"PickupServiceContext"}}}}
```

## The PickupServiceContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickupServiceContext":{"properties":{"type":{"description":"Type of this pickupService context","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"values":{"description":"Values of this pickupService context","items":{"type":"string"},"type":"array"}},"required":["type","values"],"title":"PickupServiceContext","type":"object","description":"PickupServiceContext"}}}}
```

## The PickupServiceContextInput object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickupServiceContextInput":{"properties":{"type":{"description":"Type of this pickupService context","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"values":{"description":"Values of this pickupService context","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"PickupServiceContextInput","type":"object","description":"PickupServiceContextInput"}}}}
```

## The PickupServiceForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickupServiceForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name of this pickupService"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this pickupService"},"active":{"description":"Whether this pickupService is active","type":"boolean"},"context":{"description":"The contexts in which this pickupService is available","items":{"$ref":"#/components/schemas/PickupServiceContextInput"},"maxItems":100,"type":"array"},"type":{"description":"Type of this pickupService","enum":["ID_CHECK","SIGNATURE"],"type":"string"}},"required":["type","descriptionLocalized","nameLocalized","active","context"],"title":"PickupServiceForCreation","type":"object","description":"PickupServiceForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickupServiceContextInput":{"properties":{"type":{"description":"Type of this pickupService context","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"values":{"description":"Values of this pickupService context","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"PickupServiceContextInput","type":"object","description":"PickupServiceContextInput"}}}}
```

## The PickupServiceForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickupServiceForUpdate":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized name of this pickupService"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this pickupService"},"active":{"description":"Whether this pickupService is active","type":"boolean"},"context":{"description":"The contexts in which this pickupService is available","items":{"$ref":"#/components/schemas/PickupServiceContextInput"},"maxItems":100,"type":"array"},"type":{"description":"Type of this pickupService","enum":["ID_CHECK","SIGNATURE"],"type":"string"},"version":{"description":"Version number of this pickupService","type":"number"}},"required":["version"],"title":"PickupServiceForUpdate","type":"object","description":"PickupServiceForUpdate"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PickupServiceContextInput":{"properties":{"type":{"description":"Type of this pickupService context","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"values":{"description":"Values of this pickupService context","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"PickupServiceContextInput","type":"object","description":"PickupServiceContextInput"}}}}
```

## The PickUpServiceUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PickUpServiceUpdate":{"additionalProperties":false,"properties":{"applied":{"description":"indicates if pickup service has been applied","type":"boolean"},"id":{"description":"id of the HandoverJobPickupServices you want to update","type":"string"}},"required":["id","applied"],"type":"object","title":"PickUpServiceUpdate","description":"PickUpServiceUpdate"}}}}
```

## The PostalCodeValidation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PostalCodeValidation":{"properties":{"country":{"description":"Country in Format [A-Z]{2}","type":"string"},"postalCode":{"description":"Postal code for validation","type":"string"}},"required":["country","postalCode"],"type":"object","xml":{"name":"PostalCodeValidation"},"title":"PostalCodeValidation","description":"PostalCodeValidation"}}}}
```

## The PostNlCarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PostNlCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"PostNlCarrierConfiguration","type":"object","description":"PostNlCarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The PreconfiguredGuardCondition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PreconfiguredGuardCondition":{"properties":{"kind":{"description":"Discriminator: built-in guard.","enum":["PRECONFIGURED"],"type":"string"},"preconfigured":{"description":"Which built-in guard to run","enum":["ORDER_GATE"],"type":"string"}},"required":["kind","preconfigured"],"title":"PreconfiguredGuardCondition","type":"object","description":"PreconfiguredGuardCondition"}}}}
```

## The PreferredCarrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"}}}}
```

## The PreferredCarrierWithProduct object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"}}}}
```

## The PreferredPickingMethodsConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PreferredPickingMethodsConfiguration":{"properties":{"PreferredPickingMethodsPerTag":{"items":{"$ref":"#/components/schemas/PreferredPickingMethodsPerTag"},"type":"array"}},"title":"PreferredPickingMethodsConfiguration","description":"PreferredPickingMethodsConfiguration"},"PreferredPickingMethodsPerTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"pickingMethods":{"items":{"$ref":"#/components/schemas/PickingMethodEnum"},"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","pickingMethods","matchingValues"],"title":"PreferredPickingMethodsPerTag","description":"PreferredPickingMethodsPerTag"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"}}}}
```

## The PreferredPickingMethodsPerTag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PreferredPickingMethodsPerTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"pickingMethods":{"items":{"$ref":"#/components/schemas/PickingMethodEnum"},"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","pickingMethods","matchingValues"],"title":"PreferredPickingMethodsPerTag","description":"PreferredPickingMethodsPerTag"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"}}}}
```

## The PreselectedFacility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"}}}}
```

## The PreviousModuleContainerInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The PreviousModuleContainerInfoTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The PriceRange object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The PrintableDocument object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"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"}}}}
```

## The PrintableDocumentForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PrintableDocumentForUpdate":{"properties":{"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"},"operations":{"items":{"enum":["PRINT","VIEW"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"priority":{"type":"number"},"status":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string"},"version":{"type":"number"}},"required":["version"],"title":"PrintableDocumentForUpdate","type":"object","description":"PrintableDocumentForUpdate"}}}}
```

## The PrioritizationRule object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PrioritizationRule":{"description":"You can select a default Prioritization Rule from the catalog. When you decide to select 'CUSTOM' you must also provide a vmExpression to match the type CustomPrioritizationRule.","properties":{"active":{"type":"boolean"},"id":{"description":"This value identifies this very instance of the prioritization rule. It is set autmatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/PrioritizationRuleImplementation"},"name":{"type":"string"}},"required":["active","name","implementation"],"type":"object","title":"PrioritizationRule"},"PrioritizationRuleImplementation":{"enum":["CUSTOM"],"type":"string","xml":{"name":"PrioritizationRuleImplementation"},"title":"PrioritizationRuleImplementation","description":"PrioritizationRuleImplementation"}}}}
```

## The PrioritizationRuleImplementation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PrioritizationRuleImplementation":{"enum":["CUSTOM"],"type":"string","xml":{"name":"PrioritizationRuleImplementation"},"title":"PrioritizationRuleImplementation","description":"PrioritizationRuleImplementation"}}}}
```

## The PriorityRatingResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PriorityRatingResult":{"properties":{"id":{"type":"string"},"matchesPriorityMinimum":{"type":"boolean"},"name":{"type":"string"},"routingStrategyNodeId":{"type":"string"},"type":{"$ref":"#/components/schemas/RatingResultType"}},"required":["id","type","routingStrategyNodeId","matchesPriorityMinimum"],"title":"PriorityRatingResult","description":"PriorityRatingResult"},"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"}}}}
```

## The Process object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"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"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ProcessActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessActionsParameter":{"oneOf":[{"$ref":"#/components/schemas/AddTagsToProcessActionParameter"},{"$ref":"#/components/schemas/AssignFacilityToProcessActionParameter"},{"$ref":"#/components/schemas/UpdateGdprCleanupDateActionParameter"},{"$ref":"#/components/schemas/UpdateProcessDeletionDateActionParameter"}],"title":"ProcessActionsParameter","description":"ProcessActionsParameter"},"AddTagsToProcessActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to add tags to a process.","properties":{"name":{"enum":["ADD_TAGS_TO_PROCESS"],"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":10,"minItems":1,"type":"array"}},"required":["name","version","tags"],"title":"AddTagsToProcessActionParameter"},"AbstractProcessActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractProcessActionsParameter","description":"AbstractProcessActionsParameter"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"AssignFacilityToProcessActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to assign a facility to a process.","properties":{"facilityRef":{"type":"string"},"name":{"enum":["ASSIGN_FACILITY_TO_PROCESS"],"type":"string"},"rerouteDescriptionId":{"type":"string"}},"required":["name","version","facilityRef"],"title":"AssignFacilityToProcessActionParameter"},"UpdateGdprCleanupDateActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to set the GDPR cleanup date of a process.","properties":{"gdprCleanupDate":{"description":"The date when the process and all connected entities should be cleaned up / anonymized.","format":"date","type":"string"},"name":{"enum":["UPDATE_GDPR_CLEANUP_DATE"],"type":"string"}},"required":["name","version","gdprCleanupDate"],"title":"UpdateGdprCleanupDateActionParameter"},"UpdateProcessDeletionDateActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to set the deletion date date of a process.","properties":{"deletionDate":{"description":"The date when the process must be deleted.","format":"date","type":"string"},"name":{"enum":["UPDATE_PROCESS_DELETION_DATE"],"type":"string"}},"required":["name","version","deletionDate"],"title":"UpdateProcessDeletionDateActionParameter"}}}}
```

## The ProcessAddressSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessAddressSort","type":"object","description":"ProcessAddressSort"}}}}
```

## The ProcessBrandSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessBrandSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessBrandSort","type":"object","description":"ProcessBrandSort"}}}}
```

## The ProcessCarrierSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessCarrierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessCarrierSort","type":"object","description":"ProcessCarrierSort"}}}}
```

## The ProcessConsumerAddressSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessConsumerAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessConsumerAddressSort","type":"object","description":"ProcessConsumerAddressSort"}}}}
```

## The ProcessDomainStatusesDomainStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessDomainStatusesDomainStatusEnumFilter":{"properties":{"eq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by order","items":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessDomainStatusesDomainStatusEnumFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumFilter"}}}}
```

## The ProcessDomainStatusesDomainStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessDomainStatusesDomainStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumFilter"}],"description":"Search by order"}},"title":"ProcessDomainStatusesDomainStatusEnumListFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumListFilter"},"ProcessDomainStatusesDomainStatusEnumFilter":{"properties":{"eq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by order","items":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessDomainStatusesDomainStatusEnumFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumFilter"}}}}
```

## The ProcessDomainStatusesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessDomainStatusesFilter":{"properties":{"handover":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by handover"},"order":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by order"},"packing":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by packing"},"picking":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by picking"},"return":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by return"},"routing":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by routing"},"service":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by service"},"shipping":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by shipping"}},"title":"ProcessDomainStatusesFilter","type":"object","description":"ProcessDomainStatusesFilter"},"ProcessDomainStatusesDomainStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumFilter"}],"description":"Search by order"}},"title":"ProcessDomainStatusesDomainStatusEnumListFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumListFilter"},"ProcessDomainStatusesDomainStatusEnumFilter":{"properties":{"eq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by order","items":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessDomainStatusesDomainStatusEnumFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumFilter"}}}}
```

## The Processes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Processes":{"properties":{"processes":{"items":{"$ref":"#/components/schemas/Process"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"Processes","description":"Processes"},"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"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"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ProcessFacilitySort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessFacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/ProcessAddressSort"},"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessFacilitySort","type":"object","description":"ProcessFacilitySort"},"ProcessAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessAddressSort","type":"object","description":"ProcessAddressSort"}}}}
```

## The ProcessHistoryDomainType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"}}}}
```

## The ProcessHistoryEventType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryEventType":{"description":"Event types for process history","enum":["ORDER_CREATED","LOCKED_ORDER_CREATED","DELIVERY_PROMISE_CREATED","ORDER_CANCELLED","ORDER_FORCE_CANCELLED","ORDER_UNLOCKED","ORDER_CREATED_FROM_PROMISE","ORDER_MANUAL_REROUTE","UNROUTABLE_ITEMS_REROUTE","REROUTE_FAILED","ORDER_MANUAL_FACILITY_ASSIGNMENT","ORDER_TIME_TRIGGERED_REROUTE","ORDER_HAS_UNROUTABLE_ITEMS","ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE","TASK_MANUAL_REROUTE","ORDER_MODIFICATION_REROUTE","PICKING_DONE_INCOMPLETE_REROUTE","CONSUMER_ADDRESS_CHANGED","ORDER_ITEM_AMOUNT_CHANGED","ORDER_ITEM_DELETED","ORDER_ITEM_ADDED","ORDER_PREFERRED_DATE_MODIFIED","OPERATIVE_TASK_CREATED","PICKING_IN_PROGRESS","PICKING_PAUSED","PICKING_DONE","PICKING_DONE_INCOMPLETE","PICKING_ABORTED_NO_ITEMS_PICKED","PICKING_RESET","PICKING_RESTART","PICKING_CANCELLED","PACKING_CREATED","PACKING_IN_PROGRESS","PACKING_DONE","PARCEL_CREATED","PARCEL_LABEL_REQUESTED","PARCEL_LABEL_CREATION_FAILED","HANDOVER_CREATED","HANDOVER_DONE","HANDOVER_DONE_WITH_REFUSED_ITEMS","HANDOVER_CANCELED","SERVICEJOB_CREATED","SERVICEJOB_IN_PROGRESS","SERVICEJOB_DONE","SERVICEJOB_CANCELED","ACTION_TRIGGERED","COMMENT_ADDED","RETURN_ANNOUNCED","RETURN_CANCELED","RETURN_FINISHED","REFUND_TRIGGERED"],"type":"string","title":"ProcessHistoryEventType"}}}}
```

## The ProcessHistoryLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLog":{"allOf":[{"$ref":"#/components/schemas/ProcessHistoryLogBase"}],"properties":{"eventType":{"$ref":"#/components/schemas/ProcessHistoryEventType"},"payload":{"description":"Payload varies based on eventType","nullable":true,"oneOf":[{"$ref":"#/components/schemas/RerouteLogPayload"},{"$ref":"#/components/schemas/RerouteLogPayloadBase"},{"$ref":"#/components/schemas/OrderCancellationPayload"},{"$ref":"#/components/schemas/OrderModificationPayloadBase"},{"$ref":"#/components/schemas/ConsumerAddressModifiedLogPayload"},{"$ref":"#/components/schemas/OrderModificationPreferredHandlingTimePayload"},{"$ref":"#/components/schemas/StatusReasonsPayload"},{"$ref":"#/components/schemas/OrderLineItemModifiedLogPayload"},{"$ref":"#/components/schemas/OperativeEntityPayloadBase"},{"$ref":"#/components/schemas/ExternalActionHistoryLogPayload"},{"$ref":"#/components/schemas/ParcelLabelCreationFailedPayload"},{"$ref":"#/components/schemas/OperativeEntityPickingDoneIncompletePayload"},{"$ref":"#/components/schemas/ReturnManagementPayloadBase"}],"type":"object"}},"required":["eventType"],"title":"ProcessHistoryLog","description":"ProcessHistoryLog"},"ProcessHistoryLogBase":{"properties":{"domain":{"$ref":"#/components/schemas/ProcessHistoryDomainType"},"domainRef":{"type":"string"},"eventCause":{"type":"string"},"id":{"type":"string"},"status":{"description":"Status can be OrderStatus, PickJobStatus, PackJobStatus, ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus, ItemReturnJobStatus or null","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp of the moment at which this log entry was created.","format":"date-time","type":"string"},"type":{"description":"Can be ProcessHistoryLogTypeCommon or user-defined action type","type":"string"},"user":{"$ref":"#/components/schemas/ProcessHistoryLogUser"},"version":{"nullable":true,"type":"number"},"info":{"type":"string"}},"required":["id","type","domain","status","domainRef","version","user","timestamp"],"type":"object","title":"ProcessHistoryLogBase","description":"ProcessHistoryLogBase"},"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"},"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"},"ProcessHistoryEventType":{"description":"Event types for process history","enum":["ORDER_CREATED","LOCKED_ORDER_CREATED","DELIVERY_PROMISE_CREATED","ORDER_CANCELLED","ORDER_FORCE_CANCELLED","ORDER_UNLOCKED","ORDER_CREATED_FROM_PROMISE","ORDER_MANUAL_REROUTE","UNROUTABLE_ITEMS_REROUTE","REROUTE_FAILED","ORDER_MANUAL_FACILITY_ASSIGNMENT","ORDER_TIME_TRIGGERED_REROUTE","ORDER_HAS_UNROUTABLE_ITEMS","ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE","TASK_MANUAL_REROUTE","ORDER_MODIFICATION_REROUTE","PICKING_DONE_INCOMPLETE_REROUTE","CONSUMER_ADDRESS_CHANGED","ORDER_ITEM_AMOUNT_CHANGED","ORDER_ITEM_DELETED","ORDER_ITEM_ADDED","ORDER_PREFERRED_DATE_MODIFIED","OPERATIVE_TASK_CREATED","PICKING_IN_PROGRESS","PICKING_PAUSED","PICKING_DONE","PICKING_DONE_INCOMPLETE","PICKING_ABORTED_NO_ITEMS_PICKED","PICKING_RESET","PICKING_RESTART","PICKING_CANCELLED","PACKING_CREATED","PACKING_IN_PROGRESS","PACKING_DONE","PARCEL_CREATED","PARCEL_LABEL_REQUESTED","PARCEL_LABEL_CREATION_FAILED","HANDOVER_CREATED","HANDOVER_DONE","HANDOVER_DONE_WITH_REFUSED_ITEMS","HANDOVER_CANCELED","SERVICEJOB_CREATED","SERVICEJOB_IN_PROGRESS","SERVICEJOB_DONE","SERVICEJOB_CANCELED","ACTION_TRIGGERED","COMMENT_ADDED","RETURN_ANNOUNCED","RETURN_CANCELED","RETURN_FINISHED","REFUND_TRIGGERED"],"type":"string","title":"ProcessHistoryEventType"},"RerouteLogPayload":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"},"targetFacility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"}},"required":["targetFacility"],"type":"object","title":"RerouteLogPayload","description":"RerouteLogPayload"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"RerouteLogPayloadBase":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"}},"type":"object","title":"RerouteLogPayloadBase","description":"RerouteLogPayloadBase"},"OrderCancellationPayload":{"properties":{"cancelationReason":{"$ref":"#/components/schemas/CancelationReasonHistoryLog"}},"type":"object","title":"OrderCancellationPayload","description":"OrderCancellationPayload"},"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"},"ConsumerAddressModifiedLogPayload":{"properties":{"changes":{"description":"List of address changes","items":{"$ref":"#/components/schemas/ConsumerAddressModifiedLogEntry"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogPayload","description":"ConsumerAddressModifiedLogPayload"},"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"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"},"OrderModificationPreferredHandlingTimePayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"newPreferredHandlingTime":{"description":"Updated preferredHandlingTime value","format":"date-time","nullable":true,"type":"string"},"previousPreferredHandlingTime":{"description":"preferredHandlingTime value before an update","format":"date-time","nullable":true,"type":"string"}},"required":["previousPreferredHandlingTime","newPreferredHandlingTime"],"title":"OrderModificationPreferredHandlingTimePayload","description":"OrderModificationPreferredHandlingTimePayload"},"StatusReasonsPayload":{"properties":{"statusReason":{"allOf":[{"$ref":"#/components/schemas/OrderStatusReasonLog"}],"description":"Reason for the status change","type":"object"}},"type":"object","title":"StatusReasonsPayload","description":"StatusReasonsPayload"},"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderLineItemModifiedLogPayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"articles":{"description":"List of modified articles","items":{"$ref":"#/components/schemas/ArticleHistoryLog"},"type":"array"}},"title":"OrderLineItemModifiedLogPayload","description":"OrderLineItemModifiedLogPayload"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ExternalActionHistoryLogPayload":{"properties":{"groups":{"items":{"type":"string"},"type":"array"}},"required":["groups"],"type":"object","title":"ExternalActionHistoryLogPayload","description":"ExternalActionHistoryLogPayload"},"ParcelLabelCreationFailedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"errorMessage":{"type":"string"}},"required":["errorMessage"],"type":"object","title":"ParcelLabelCreationFailedPayload","description":"ParcelLabelCreationFailedPayload"},"OperativeEntityPickingDoneIncompletePayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"shortPickedItems":{"items":{"$ref":"#/components/schemas/OperativeEntityShortPickedItem"},"type":"array"}},"title":"OperativeEntityPickingDoneIncompletePayload","description":"OperativeEntityPickingDoneIncompletePayload"},"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"}}}}
```

## The ProcessHistoryLogBase object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLogBase":{"properties":{"domain":{"$ref":"#/components/schemas/ProcessHistoryDomainType"},"domainRef":{"type":"string"},"eventCause":{"type":"string"},"id":{"type":"string"},"status":{"description":"Status can be OrderStatus, PickJobStatus, PackJobStatus, ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus, ItemReturnJobStatus or null","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp of the moment at which this log entry was created.","format":"date-time","type":"string"},"type":{"description":"Can be ProcessHistoryLogTypeCommon or user-defined action type","type":"string"},"user":{"$ref":"#/components/schemas/ProcessHistoryLogUser"},"version":{"nullable":true,"type":"number"},"info":{"type":"string"}},"required":["id","type","domain","status","domainRef","version","user","timestamp"],"type":"object","title":"ProcessHistoryLogBase","description":"ProcessHistoryLogBase"},"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"},"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"}}}}
```

## The ProcessHistoryLogFacility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ProcessHistoryLogFacilityGroup object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ProcessHistoryLogs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLogs":{"properties":{"historyLogs":{"items":{"$ref":"#/components/schemas/ProcessHistoryLog"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"ProcessHistoryLogs","description":"ProcessHistoryLogs"},"ProcessHistoryLog":{"allOf":[{"$ref":"#/components/schemas/ProcessHistoryLogBase"}],"properties":{"eventType":{"$ref":"#/components/schemas/ProcessHistoryEventType"},"payload":{"description":"Payload varies based on eventType","nullable":true,"oneOf":[{"$ref":"#/components/schemas/RerouteLogPayload"},{"$ref":"#/components/schemas/RerouteLogPayloadBase"},{"$ref":"#/components/schemas/OrderCancellationPayload"},{"$ref":"#/components/schemas/OrderModificationPayloadBase"},{"$ref":"#/components/schemas/ConsumerAddressModifiedLogPayload"},{"$ref":"#/components/schemas/OrderModificationPreferredHandlingTimePayload"},{"$ref":"#/components/schemas/StatusReasonsPayload"},{"$ref":"#/components/schemas/OrderLineItemModifiedLogPayload"},{"$ref":"#/components/schemas/OperativeEntityPayloadBase"},{"$ref":"#/components/schemas/ExternalActionHistoryLogPayload"},{"$ref":"#/components/schemas/ParcelLabelCreationFailedPayload"},{"$ref":"#/components/schemas/OperativeEntityPickingDoneIncompletePayload"},{"$ref":"#/components/schemas/ReturnManagementPayloadBase"}],"type":"object"}},"required":["eventType"],"title":"ProcessHistoryLog","description":"ProcessHistoryLog"},"ProcessHistoryLogBase":{"properties":{"domain":{"$ref":"#/components/schemas/ProcessHistoryDomainType"},"domainRef":{"type":"string"},"eventCause":{"type":"string"},"id":{"type":"string"},"status":{"description":"Status can be OrderStatus, PickJobStatus, PackJobStatus, ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus, ItemReturnJobStatus or null","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp of the moment at which this log entry was created.","format":"date-time","type":"string"},"type":{"description":"Can be ProcessHistoryLogTypeCommon or user-defined action type","type":"string"},"user":{"$ref":"#/components/schemas/ProcessHistoryLogUser"},"version":{"nullable":true,"type":"number"},"info":{"type":"string"}},"required":["id","type","domain","status","domainRef","version","user","timestamp"],"type":"object","title":"ProcessHistoryLogBase","description":"ProcessHistoryLogBase"},"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"},"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"},"ProcessHistoryEventType":{"description":"Event types for process history","enum":["ORDER_CREATED","LOCKED_ORDER_CREATED","DELIVERY_PROMISE_CREATED","ORDER_CANCELLED","ORDER_FORCE_CANCELLED","ORDER_UNLOCKED","ORDER_CREATED_FROM_PROMISE","ORDER_MANUAL_REROUTE","UNROUTABLE_ITEMS_REROUTE","REROUTE_FAILED","ORDER_MANUAL_FACILITY_ASSIGNMENT","ORDER_TIME_TRIGGERED_REROUTE","ORDER_HAS_UNROUTABLE_ITEMS","ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE","TASK_MANUAL_REROUTE","ORDER_MODIFICATION_REROUTE","PICKING_DONE_INCOMPLETE_REROUTE","CONSUMER_ADDRESS_CHANGED","ORDER_ITEM_AMOUNT_CHANGED","ORDER_ITEM_DELETED","ORDER_ITEM_ADDED","ORDER_PREFERRED_DATE_MODIFIED","OPERATIVE_TASK_CREATED","PICKING_IN_PROGRESS","PICKING_PAUSED","PICKING_DONE","PICKING_DONE_INCOMPLETE","PICKING_ABORTED_NO_ITEMS_PICKED","PICKING_RESET","PICKING_RESTART","PICKING_CANCELLED","PACKING_CREATED","PACKING_IN_PROGRESS","PACKING_DONE","PARCEL_CREATED","PARCEL_LABEL_REQUESTED","PARCEL_LABEL_CREATION_FAILED","HANDOVER_CREATED","HANDOVER_DONE","HANDOVER_DONE_WITH_REFUSED_ITEMS","HANDOVER_CANCELED","SERVICEJOB_CREATED","SERVICEJOB_IN_PROGRESS","SERVICEJOB_DONE","SERVICEJOB_CANCELED","ACTION_TRIGGERED","COMMENT_ADDED","RETURN_ANNOUNCED","RETURN_CANCELED","RETURN_FINISHED","REFUND_TRIGGERED"],"type":"string","title":"ProcessHistoryEventType"},"RerouteLogPayload":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"},"targetFacility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"}},"required":["targetFacility"],"type":"object","title":"RerouteLogPayload","description":"RerouteLogPayload"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"RerouteLogPayloadBase":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"}},"type":"object","title":"RerouteLogPayloadBase","description":"RerouteLogPayloadBase"},"OrderCancellationPayload":{"properties":{"cancelationReason":{"$ref":"#/components/schemas/CancelationReasonHistoryLog"}},"type":"object","title":"OrderCancellationPayload","description":"OrderCancellationPayload"},"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"},"ConsumerAddressModifiedLogPayload":{"properties":{"changes":{"description":"List of address changes","items":{"$ref":"#/components/schemas/ConsumerAddressModifiedLogEntry"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogPayload","description":"ConsumerAddressModifiedLogPayload"},"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"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"},"OrderModificationPreferredHandlingTimePayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"newPreferredHandlingTime":{"description":"Updated preferredHandlingTime value","format":"date-time","nullable":true,"type":"string"},"previousPreferredHandlingTime":{"description":"preferredHandlingTime value before an update","format":"date-time","nullable":true,"type":"string"}},"required":["previousPreferredHandlingTime","newPreferredHandlingTime"],"title":"OrderModificationPreferredHandlingTimePayload","description":"OrderModificationPreferredHandlingTimePayload"},"StatusReasonsPayload":{"properties":{"statusReason":{"allOf":[{"$ref":"#/components/schemas/OrderStatusReasonLog"}],"description":"Reason for the status change","type":"object"}},"type":"object","title":"StatusReasonsPayload","description":"StatusReasonsPayload"},"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderLineItemModifiedLogPayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"articles":{"description":"List of modified articles","items":{"$ref":"#/components/schemas/ArticleHistoryLog"},"type":"array"}},"title":"OrderLineItemModifiedLogPayload","description":"OrderLineItemModifiedLogPayload"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ExternalActionHistoryLogPayload":{"properties":{"groups":{"items":{"type":"string"},"type":"array"}},"required":["groups"],"type":"object","title":"ExternalActionHistoryLogPayload","description":"ExternalActionHistoryLogPayload"},"ParcelLabelCreationFailedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"errorMessage":{"type":"string"}},"required":["errorMessage"],"type":"object","title":"ParcelLabelCreationFailedPayload","description":"ParcelLabelCreationFailedPayload"},"OperativeEntityPickingDoneIncompletePayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"shortPickedItems":{"items":{"$ref":"#/components/schemas/OperativeEntityShortPickedItem"},"type":"array"}},"title":"OperativeEntityPickingDoneIncompletePayload","description":"OperativeEntityPickingDoneIncompletePayload"},"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"}}}}
```

## The ProcessHistoryLogSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLogSort":{"description":"Attribute to order a process history log by","enum":["TIMESTAMP_DESC","TIMESTAMP_ASC","INFO_DESC","INFO_ASC","TYPE_ASC","TYPE_DESC","USERNAME_DESC","USERNAME_ASC","FACILITY_NAME_DESC","FACILITY_NAME_ASC"],"type":"string","xml":{"name":"ProcessHistoryLogSort"},"title":"ProcessHistoryLogSort"}}}}
```

## The ProcessHistoryLogTypeCommon object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLogTypeCommon":{"description":"Common log types for process history","enum":["ORDER_LIFECYCLE","ROUTING","FULFILLMENT","ORDER_MODIFICATION","COMMENT","RETURN_MANAGEMENT"],"type":"string","title":"ProcessHistoryLogTypeCommon"}}}}
```

## The ProcessHistoryLogUser object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"}}}}
```

## The ProcessInput object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessInput":{"properties":{"handoverJobRef":{"type":"string"},"orderRef":{"type":"string"},"pickJobRef":{"type":"string"},"returnRef":{"type":"string"},"shipmentRef":{"type":"string"},"tenantOrderId":{"type":"string"}},"title":"ProcessInput","description":"ProcessInput"}}}}
```

## The ProcessOrderSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessOrderSort":{"properties":{"desiredDeliveryTime":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"orderedAmount":{"enum":["ASC","DESC"],"type":"string"},"provisioningTime":{"enum":["ASC","DESC"],"type":"string"},"tenantOrderId":{"enum":["ASC","DESC"],"type":"string"},"updateDetails":{"allOf":[{"$ref":"#/components/schemas/ProcessUpdateDetailsSort"}]}},"title":"ProcessOrderSort","type":"object","description":"ProcessOrderSort"},"ProcessUpdateDetailsSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"user":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessUpdateDetailsSort","type":"object","description":"ProcessUpdateDetailsSort"}}}}
```

## The ProcessPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"processes":{"items":{"$ref":"#/components/schemas/Process"},"type":"array"},"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","processes"],"title":"ProcessPaginatedResult","type":"object","description":"ProcessPaginatedResult"},"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"},"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"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"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ProcessPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/AddTagsToProcess"},{"$ref":"#/components/schemas/AssignFacilityToProcess"},{"$ref":"#/components/schemas/UpdateGdprCleanupDateAction"}]},"maxItems":500,"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":"ProcessPatchActions"},"title":"ProcessPatchActions","description":"ProcessPatchActions"},"AddTagsToProcess":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'AddTagsToProcess', because you want to modify a process","enum":["AddTagsToProcess"],"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["action"],"type":"object"}],"description":"Action to add tags to a Process","title":"AddTagsToProcessAction","xml":{"name":"AddTagsToProcess"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"AssignFacilityToProcess":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value to manually assign a facility to a process","enum":["AssignFacilityToProcess"],"type":"string"},"facilityRef":{"type":"string"},"rerouteDescriptionId":{"type":"string"}},"required":["action","facilityRef"],"type":"object"}],"description":"Action to assign a process to a facility.","title":"AssignFacilityToProcessAction","xml":{"name":"AssignFacilityToProcess"}},"UpdateGdprCleanupDateAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'UpdateGdprCleanupDateAction' to update the GDPR cleanup date of a process.","enum":["UpdateGdprCleanupDateAction"],"type":"string"},"gdprCleanupDate":{"description":"The date when the process and all connected entities should be cleaned up / anonymized.","format":"date","type":"string"}},"required":["action","gdprCleanupDate"],"type":"object"}],"description":"Action to set the GDPR cleanup date of a process.","title":"UpdateGdprCleanupDateAction","xml":{"name":"UpdateGdprCleanupDateAction"}}}}}
```

## The ProcessProgressLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessProgressLog":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"attributes":{"type":"object"},"domain":{"$ref":"#/components/schemas/DomainType"},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus"},"domainLastModified":{"description":"The last modified date of the related domain entity","format":"date-time","type":"string"},"domainRef":{"type":"string"},"domainStatus":{"type":"string"},"domainVersion":{"description":"The version of the related domain entity","format":"int64","type":"integer"},"facilityRef":{"description":"The id of the facility an entity possibly belongs to.","type":"string"},"id":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"moduleEntityLastModified":{"description":"The last modified date of the related module entity","format":"date-time","type":"string"},"moduleEntityRef":{"type":"string"},"moduleEntityStatus":{"description":"Original status of the related module entity","type":"string"},"moduleEntityStatusForProcess":{"$ref":"#/components/schemas/ModuleEntityStatus","description":"Module entity's original status mapped to the ModuleEntityStatus for process"},"moduleEntitySubStatuses":{"description":"Sub-statuses reported by the module entity for this progress log entry.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"moduleEntityVersion":{"description":"The version of the related module entity","format":"int64","type":"integer"},"processRef":{"type":"string"},"schemaVersion":{"type":"number"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each module can define its own set of reasons, represented as an ENUM","type":"string"}},"required":["id","domainVersion","processRef","domainEntityProcessStatus","domain","domainRef","domainStatus"],"title":"ProcessProgressLog","description":"ProcessProgressLog"},"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"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"}}}}
```

## The ProcessReferencedBrandFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedBrandFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedBrandFilter","type":"object","description":"ProcessReferencedBrandFilter"},"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"}}}}
```

## The ProcessReferencedCarrierFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedCarrierFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by carrierTrackingNumber"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedCarrierFilter","type":"object","description":"ProcessReferencedCarrierFilter"},"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"}}}}
```

## The ProcessReferencedConsumerAddressFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedConsumerAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"deliveryCountry":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by deliveryCountry"}},"title":"ProcessReferencedConsumerAddressFilter","type":"object","description":"ProcessReferencedConsumerAddressFilter"},"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"}}}}
```

## The ProcessReferencedFacilityAddressFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedFacilityAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"}},"title":"ProcessReferencedFacilityAddressFilter","type":"object","description":"ProcessReferencedFacilityAddressFilter"},"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"}}}}
```

## The ProcessReferencedFacilityFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedFacilityFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityAddressFilter"}],"description":"Nested search by address"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedFacilityFilter","type":"object","description":"ProcessReferencedFacilityFilter"},"ProcessReferencedFacilityAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"}},"title":"ProcessReferencedFacilityAddressFilter","type":"object","description":"ProcessReferencedFacilityAddressFilter"},"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"}}}}
```

## The ProcessReferencedFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedFilter":{"properties":{"brand":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedBrandFilter"}],"description":"Nested search by brand"},"carrier":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedCarrierFilter"}],"description":"Nested search by carrier"},"consumerAddress":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedConsumerAddressFilter"}],"description":"Nested search by consumerAddress"},"facility":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityFilter"}],"description":"Nested search by facility"},"handoverJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobFilter"}],"description":"Nested search by handoverJob"},"order":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderFilter"}],"description":"Nested search by order"},"packJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobFilter"}],"description":"Nested search by packJob"},"parcel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelFilter"}],"description":"Nested search by parcel"},"parcelTrackingStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumListFilter"}],"description":"Search by parcelTrackingStatus"},"pickJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobFilter"}],"description":"Nested search by pickJob"},"returnJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobFilter"}],"description":"Nested search by returnJob"},"routingPlan":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanFilter"}],"description":"Nested search by routingPlan"},"serviceJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobFilter"}],"description":"Nested search by serviceJob"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumListFilter"}],"description":"Search by serviceLevel"},"serviceType":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by serviceType"},"shipment":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentFilter"}],"description":"Nested search by shipment"},"sticker":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedStickerFilter"}],"description":"Nested search by sticker"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"}},"title":"ProcessReferencedFilter","type":"object","description":"ProcessReferencedFilter"},"ProcessReferencedBrandFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedBrandFilter","type":"object","description":"ProcessReferencedBrandFilter"},"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"},"ProcessReferencedCarrierFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by carrierTrackingNumber"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedCarrierFilter","type":"object","description":"ProcessReferencedCarrierFilter"},"ProcessReferencedConsumerAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"deliveryCountry":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by deliveryCountry"}},"title":"ProcessReferencedConsumerAddressFilter","type":"object","description":"ProcessReferencedConsumerAddressFilter"},"ProcessReferencedFacilityFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityAddressFilter"}],"description":"Nested search by address"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedFacilityFilter","type":"object","description":"ProcessReferencedFacilityFilter"},"ProcessReferencedFacilityAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"}},"title":"ProcessReferencedFacilityAddressFilter","type":"object","description":"ProcessReferencedFacilityAddressFilter"},"ProcessReferencedHandoverJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"pickupIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by pickupIdentifier"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobFilter","type":"object","description":"ProcessReferencedHandoverJobFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessReferencedHandoverJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedHandoverJobGlobalActorFilter","type":"object","description":"ProcessReferencedHandoverJobGlobalActorFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter":{"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":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"},"ProcessReferencedOrderFilter":{"properties":{"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerId"},"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderGlobalActorFilter"}],"description":"Nested search by globalActor"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by orderDate"},"orderedAmount":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by orderedAmount"},"provisioningTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by provisioningTime"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumListFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"ProcessReferencedOrderFilter","type":"object","description":"ProcessReferencedOrderFilter"},"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"},"ProcessReferencedOrderGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedOrderGlobalActorFilter","type":"object","description":"ProcessReferencedOrderGlobalActorFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ProcessReferencedOrderOrderStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedOrderOrderStatusEnumListFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumListFilter"},"ProcessReferencedOrderOrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedOrderOrderStatusEnumFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumFilter"},"ProcessReferencedPackJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobFilter","type":"object","description":"ProcessReferencedPackJobFilter"},"ProcessReferencedPackJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPackJobGlobalActorFilter","type":"object","description":"ProcessReferencedPackJobGlobalActorFilter"},"ProcessReferencedPackJobPackJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobPackJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumListFilter"},"ProcessReferencedPackJobPackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"ProcessReferencedPackJobPackJobStatusEnumFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumFilter"},"ProcessReferencedParcelFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelFilter","type":"object","description":"ProcessReferencedParcelFilter"},"ProcessReferencedParcelParcelStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelParcelStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumListFilter"},"ProcessReferencedParcelParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ProcessReferencedParcelParcelStatusEnumFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumFilter"},"ProcessReferencedParcelTrackingStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumFilter"}],"description":"Search by parcelTrackingStatus"}},"title":"ProcessReferencedParcelTrackingStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumListFilter"},"ProcessReferencedParcelTrackingStatusEnumFilter":{"properties":{"eq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"in":{"description":"Search by parcelTrackingStatus","items":{"enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"}},"title":"ProcessReferencedParcelTrackingStatusEnumFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumFilter"},"ProcessReferencedPickJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobFilter","type":"object","description":"ProcessReferencedPickJobFilter"},"ProcessReferencedPickJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPickJobGlobalActorFilter","type":"object","description":"ProcessReferencedPickJobGlobalActorFilter"},"ProcessReferencedPickJobPickJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobPickJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumListFilter"},"ProcessReferencedPickJobPickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"ProcessReferencedPickJobPickJobStatusEnumFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumFilter"},"ProcessReferencedReturnJobFilter":{"properties":{"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"returnFacilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by returnFacilityRefs"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobFilter","type":"object","description":"ProcessReferencedReturnJobFilter"},"ProcessReferencedReturnJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedReturnJobGlobalActorFilter","type":"object","description":"ProcessReferencedReturnJobGlobalActorFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"},"ProcessReferencedRoutingPlanFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanFilter","type":"object","description":"ProcessReferencedRoutingPlanFilter"},"ProcessReferencedRoutingPlanGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedRoutingPlanGlobalActorFilter","type":"object","description":"ProcessReferencedRoutingPlanGlobalActorFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"},"ProcessReferencedServiceJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobFilter","type":"object","description":"ProcessReferencedServiceJobFilter"},"ProcessReferencedServiceJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedServiceJobGlobalActorFilter","type":"object","description":"ProcessReferencedServiceJobGlobalActorFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumFilter"},"ProcessReferencedServiceLevelEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"ProcessReferencedServiceLevelEnumListFilter","type":"object","description":"ProcessReferencedServiceLevelEnumListFilter"},"ProcessReferencedServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"ProcessReferencedServiceLevelEnumFilter","type":"object","description":"ProcessReferencedServiceLevelEnumFilter"},"ProcessReferencedShipmentFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentFilter","type":"object","description":"ProcessReferencedShipmentFilter"},"ProcessReferencedShipmentShipmentStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentShipmentStatusEnumListFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumListFilter"},"ProcessReferencedShipmentShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedShipmentShipmentStatusEnumFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumFilter"},"ProcessReferencedStickerFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedStickerFilter","type":"object","description":"ProcessReferencedStickerFilter"}}}}
```

## The ProcessReferencedHandoverJobFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedHandoverJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"pickupIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by pickupIdentifier"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobFilter","type":"object","description":"ProcessReferencedHandoverJobFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessReferencedHandoverJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedHandoverJobGlobalActorFilter","type":"object","description":"ProcessReferencedHandoverJobGlobalActorFilter"},"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"},"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter":{"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":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}}}}
```

## The ProcessReferencedHandoverJobGlobalActorFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedHandoverJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedHandoverJobGlobalActorFilter","type":"object","description":"ProcessReferencedHandoverJobGlobalActorFilter"},"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"}}}}
```

## The ProcessReferencedHandoverJobHandoverjobStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter":{"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":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}}}}
```

## The ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter":{"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":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}}}}
```

## The ProcessReferencedOrderFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedOrderFilter":{"properties":{"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerId"},"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderGlobalActorFilter"}],"description":"Nested search by globalActor"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by orderDate"},"orderedAmount":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by orderedAmount"},"provisioningTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by provisioningTime"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumListFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"ProcessReferencedOrderFilter","type":"object","description":"ProcessReferencedOrderFilter"},"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"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessReferencedOrderGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedOrderGlobalActorFilter","type":"object","description":"ProcessReferencedOrderGlobalActorFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ProcessReferencedOrderOrderStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedOrderOrderStatusEnumListFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumListFilter"},"ProcessReferencedOrderOrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedOrderOrderStatusEnumFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumFilter"}}}}
```

## The ProcessReferencedOrderGlobalActorFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedOrderGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedOrderGlobalActorFilter","type":"object","description":"ProcessReferencedOrderGlobalActorFilter"},"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"}}}}
```

## The ProcessReferencedOrderOrderStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedOrderOrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedOrderOrderStatusEnumFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumFilter"}}}}
```

## The ProcessReferencedOrderOrderStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedOrderOrderStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedOrderOrderStatusEnumListFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumListFilter"},"ProcessReferencedOrderOrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedOrderOrderStatusEnumFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumFilter"}}}}
```

## The ProcessReferencedPackJobFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedPackJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobFilter","type":"object","description":"ProcessReferencedPackJobFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessReferencedPackJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPackJobGlobalActorFilter","type":"object","description":"ProcessReferencedPackJobGlobalActorFilter"},"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"},"ProcessReferencedPackJobPackJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobPackJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumListFilter"},"ProcessReferencedPackJobPackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"ProcessReferencedPackJobPackJobStatusEnumFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumFilter"}}}}
```

## The ProcessReferencedPackJobGlobalActorFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedPackJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPackJobGlobalActorFilter","type":"object","description":"ProcessReferencedPackJobGlobalActorFilter"},"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"}}}}
```

## The ProcessReferencedPackJobPackJobStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedPackJobPackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"ProcessReferencedPackJobPackJobStatusEnumFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumFilter"}}}}
```

## The ProcessReferencedPackJobPackJobStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedPackJobPackJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobPackJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumListFilter"},"ProcessReferencedPackJobPackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"ProcessReferencedPackJobPackJobStatusEnumFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumFilter"}}}}
```

## The ProcessReferencedParcelFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedParcelFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelFilter","type":"object","description":"ProcessReferencedParcelFilter"},"ProcessReferencedParcelParcelStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelParcelStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumListFilter"},"ProcessReferencedParcelParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ProcessReferencedParcelParcelStatusEnumFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumFilter"}}}}
```

## The ProcessReferencedParcelParcelStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedParcelParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ProcessReferencedParcelParcelStatusEnumFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumFilter"}}}}
```

## The ProcessReferencedParcelParcelStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedParcelParcelStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelParcelStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumListFilter"},"ProcessReferencedParcelParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ProcessReferencedParcelParcelStatusEnumFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumFilter"}}}}
```

## The ProcessReferencedParcelTrackingStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedParcelTrackingStatusEnumFilter":{"properties":{"eq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"in":{"description":"Search by parcelTrackingStatus","items":{"enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"}},"title":"ProcessReferencedParcelTrackingStatusEnumFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumFilter"}}}}
```

## The ProcessReferencedParcelTrackingStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedParcelTrackingStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumFilter"}],"description":"Search by parcelTrackingStatus"}},"title":"ProcessReferencedParcelTrackingStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumListFilter"},"ProcessReferencedParcelTrackingStatusEnumFilter":{"properties":{"eq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"in":{"description":"Search by parcelTrackingStatus","items":{"enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"}},"title":"ProcessReferencedParcelTrackingStatusEnumFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumFilter"}}}}
```

## The ProcessReferencedPickJobFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedPickJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobFilter","type":"object","description":"ProcessReferencedPickJobFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessReferencedPickJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPickJobGlobalActorFilter","type":"object","description":"ProcessReferencedPickJobGlobalActorFilter"},"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"},"ProcessReferencedPickJobPickJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobPickJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumListFilter"},"ProcessReferencedPickJobPickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"ProcessReferencedPickJobPickJobStatusEnumFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumFilter"}}}}
```

## The ProcessReferencedPickJobGlobalActorFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedPickJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPickJobGlobalActorFilter","type":"object","description":"ProcessReferencedPickJobGlobalActorFilter"},"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"}}}}
```

## The ProcessReferencedPickJobPickJobStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedPickJobPickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"ProcessReferencedPickJobPickJobStatusEnumFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumFilter"}}}}
```

## The ProcessReferencedPickJobPickJobStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedPickJobPickJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobPickJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumListFilter"},"ProcessReferencedPickJobPickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"ProcessReferencedPickJobPickJobStatusEnumFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumFilter"}}}}
```

## The ProcessReferencedReturnJobFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedReturnJobFilter":{"properties":{"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"returnFacilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by returnFacilityRefs"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobFilter","type":"object","description":"ProcessReferencedReturnJobFilter"},"ProcessReferencedReturnJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedReturnJobGlobalActorFilter","type":"object","description":"ProcessReferencedReturnJobGlobalActorFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}}}}
```

## The ProcessReferencedReturnJobGlobalActorFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedReturnJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedReturnJobGlobalActorFilter","type":"object","description":"ProcessReferencedReturnJobGlobalActorFilter"},"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"}}}}
```

## The ProcessReferencedReturnJobItemReturnJobStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}}}}
```

## The ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}}}}
```

## The ProcessReferencedRoutingPlanFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedRoutingPlanFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanFilter","type":"object","description":"ProcessReferencedRoutingPlanFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessReferencedRoutingPlanGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedRoutingPlanGlobalActorFilter","type":"object","description":"ProcessReferencedRoutingPlanGlobalActorFilter"},"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"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}}}}
```

## The ProcessReferencedRoutingPlanGlobalActorFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedRoutingPlanGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedRoutingPlanGlobalActorFilter","type":"object","description":"ProcessReferencedRoutingPlanGlobalActorFilter"},"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"}}}}
```

## The ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}}}}
```

## The ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}}}}
```

## The ProcessReferencedServiceJobFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedServiceJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobFilter","type":"object","description":"ProcessReferencedServiceJobFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessReferencedServiceJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedServiceJobGlobalActorFilter","type":"object","description":"ProcessReferencedServiceJobGlobalActorFilter"},"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"},"ProcessReferencedServiceJobServiceJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumFilter"}}}}
```

## The ProcessReferencedServiceJobGlobalActorFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedServiceJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedServiceJobGlobalActorFilter","type":"object","description":"ProcessReferencedServiceJobGlobalActorFilter"},"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"}}}}
```

## The ProcessReferencedServiceJobServiceJobStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedServiceJobServiceJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumFilter"}}}}
```

## The ProcessReferencedServiceJobServiceJobStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedServiceJobServiceJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumFilter"}}}}
```

## The ProcessReferencedServiceLevelEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"ProcessReferencedServiceLevelEnumFilter","type":"object","description":"ProcessReferencedServiceLevelEnumFilter"}}}}
```

## The ProcessReferencedServiceLevelEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedServiceLevelEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"ProcessReferencedServiceLevelEnumListFilter","type":"object","description":"ProcessReferencedServiceLevelEnumListFilter"},"ProcessReferencedServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"ProcessReferencedServiceLevelEnumFilter","type":"object","description":"ProcessReferencedServiceLevelEnumFilter"}}}}
```

## The ProcessReferencedShipmentFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedShipmentFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentFilter","type":"object","description":"ProcessReferencedShipmentFilter"},"ProcessReferencedShipmentShipmentStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentShipmentStatusEnumListFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumListFilter"},"ProcessReferencedShipmentShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedShipmentShipmentStatusEnumFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumFilter"}}}}
```

## The ProcessReferencedShipmentShipmentStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedShipmentShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedShipmentShipmentStatusEnumFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumFilter"}}}}
```

## The ProcessReferencedShipmentShipmentStatusEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedShipmentShipmentStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentShipmentStatusEnumListFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumListFilter"},"ProcessReferencedShipmentShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedShipmentShipmentStatusEnumFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumFilter"}}}}
```

## The ProcessReferencedSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedSort":{"properties":{"brand":{"$ref":"#/components/schemas/ProcessBrandSort"},"carrier":{"$ref":"#/components/schemas/ProcessCarrierSort"},"consumerAddress":{"$ref":"#/components/schemas/ProcessConsumerAddressSort"},"facility":{"$ref":"#/components/schemas/ProcessFacilitySort"},"order":{"$ref":"#/components/schemas/ProcessOrderSort"},"parcelTrackingStatus":{"enum":["ASC","DESC"],"type":"string"},"sticker":{"$ref":"#/components/schemas/ProcessStickerSort"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessReferencedSort","type":"object","description":"ProcessReferencedSort"},"ProcessBrandSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessBrandSort","type":"object","description":"ProcessBrandSort"},"ProcessCarrierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessCarrierSort","type":"object","description":"ProcessCarrierSort"},"ProcessConsumerAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessConsumerAddressSort","type":"object","description":"ProcessConsumerAddressSort"},"ProcessFacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/ProcessAddressSort"},"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessFacilitySort","type":"object","description":"ProcessFacilitySort"},"ProcessAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessAddressSort","type":"object","description":"ProcessAddressSort"},"ProcessOrderSort":{"properties":{"desiredDeliveryTime":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"orderedAmount":{"enum":["ASC","DESC"],"type":"string"},"provisioningTime":{"enum":["ASC","DESC"],"type":"string"},"tenantOrderId":{"enum":["ASC","DESC"],"type":"string"},"updateDetails":{"allOf":[{"$ref":"#/components/schemas/ProcessUpdateDetailsSort"}]}},"title":"ProcessOrderSort","type":"object","description":"ProcessOrderSort"},"ProcessUpdateDetailsSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"user":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessUpdateDetailsSort","type":"object","description":"ProcessUpdateDetailsSort"},"ProcessStickerSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessStickerSort","type":"object","description":"ProcessStickerSort"}}}}
```

## The ProcessReferencedStickerFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessReferencedStickerFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedStickerFilter","type":"object","description":"ProcessReferencedStickerFilter"},"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"}}}}
```

## The ProcessSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessSearchPayload":{"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/ProcessSearchQuery"},"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/ProcessSort"},"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":"ProcessSearchPayload","type":"object","description":"ProcessSearchPayload"},"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"},"ProcessSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ProcessSearchQuery"},"maxItems":500,"type":"array"},"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by carrierManagementStatuses"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by created"},"documentRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by documentRefs"},"domainStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesFilter"}],"description":"Nested search by domainStatuses"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by domsStatus"},"externalActionRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by externalActionRefs"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"facilityRefsWithActiveOperations":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRefsWithActiveOperations"},"flatRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by flatRefs"},"handoverJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by handoverJobRefs"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by inventoryStatus"},"itemReturnJobsRef":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by itemReturnJobsRef"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by operativeStatus"},"or":{"items":{"$ref":"#/components/schemas/ProcessSearchQuery"},"maxItems":500,"type":"array"},"orderRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by orderRef"},"packJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by packJobRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"processId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by processId"},"referenced":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFilter"}],"description":"Nested search by referenced"},"returnRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by returnRefs"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by returnStatus"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"searchTerm":{"allOf":[{"$ref":"#/components/schemas/SearchFilter"}],"description":"Full-text search for this entity"},"serviceJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by serviceJobRefs"},"shipmentRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by shipmentRefs"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by status"},"tags":{"allOf":[{"$ref":"#/components/schemas/ProcessTagsListFilter"}],"description":"Nested list search by tags"}},"title":"ProcessSearchQuery","type":"object","description":"ProcessSearchQuery"},"ProcessStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"}},"title":"ProcessStatusEnumFilter","type":"object","description":"ProcessStatusEnumFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessDomainStatusesFilter":{"properties":{"handover":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by handover"},"order":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by order"},"packing":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by packing"},"picking":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by picking"},"return":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by return"},"routing":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by routing"},"service":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by service"},"shipping":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by shipping"}},"title":"ProcessDomainStatusesFilter","type":"object","description":"ProcessDomainStatusesFilter"},"ProcessDomainStatusesDomainStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumFilter"}],"description":"Search by order"}},"title":"ProcessDomainStatusesDomainStatusEnumListFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumListFilter"},"ProcessDomainStatusesDomainStatusEnumFilter":{"properties":{"eq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by order","items":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessDomainStatusesDomainStatusEnumFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumFilter"},"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"},"ProcessReferencedFilter":{"properties":{"brand":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedBrandFilter"}],"description":"Nested search by brand"},"carrier":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedCarrierFilter"}],"description":"Nested search by carrier"},"consumerAddress":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedConsumerAddressFilter"}],"description":"Nested search by consumerAddress"},"facility":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityFilter"}],"description":"Nested search by facility"},"handoverJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobFilter"}],"description":"Nested search by handoverJob"},"order":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderFilter"}],"description":"Nested search by order"},"packJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobFilter"}],"description":"Nested search by packJob"},"parcel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelFilter"}],"description":"Nested search by parcel"},"parcelTrackingStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumListFilter"}],"description":"Search by parcelTrackingStatus"},"pickJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobFilter"}],"description":"Nested search by pickJob"},"returnJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobFilter"}],"description":"Nested search by returnJob"},"routingPlan":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanFilter"}],"description":"Nested search by routingPlan"},"serviceJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobFilter"}],"description":"Nested search by serviceJob"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumListFilter"}],"description":"Search by serviceLevel"},"serviceType":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by serviceType"},"shipment":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentFilter"}],"description":"Nested search by shipment"},"sticker":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedStickerFilter"}],"description":"Nested search by sticker"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"}},"title":"ProcessReferencedFilter","type":"object","description":"ProcessReferencedFilter"},"ProcessReferencedBrandFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedBrandFilter","type":"object","description":"ProcessReferencedBrandFilter"},"ProcessReferencedCarrierFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by carrierTrackingNumber"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedCarrierFilter","type":"object","description":"ProcessReferencedCarrierFilter"},"ProcessReferencedConsumerAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"deliveryCountry":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by deliveryCountry"}},"title":"ProcessReferencedConsumerAddressFilter","type":"object","description":"ProcessReferencedConsumerAddressFilter"},"ProcessReferencedFacilityFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityAddressFilter"}],"description":"Nested search by address"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedFacilityFilter","type":"object","description":"ProcessReferencedFacilityFilter"},"ProcessReferencedFacilityAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"}},"title":"ProcessReferencedFacilityAddressFilter","type":"object","description":"ProcessReferencedFacilityAddressFilter"},"ProcessReferencedHandoverJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"pickupIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by pickupIdentifier"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobFilter","type":"object","description":"ProcessReferencedHandoverJobFilter"},"ProcessReferencedHandoverJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedHandoverJobGlobalActorFilter","type":"object","description":"ProcessReferencedHandoverJobGlobalActorFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter":{"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":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"},"ProcessReferencedOrderFilter":{"properties":{"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerId"},"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderGlobalActorFilter"}],"description":"Nested search by globalActor"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by orderDate"},"orderedAmount":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by orderedAmount"},"provisioningTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by provisioningTime"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumListFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"ProcessReferencedOrderFilter","type":"object","description":"ProcessReferencedOrderFilter"},"ProcessReferencedOrderGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedOrderGlobalActorFilter","type":"object","description":"ProcessReferencedOrderGlobalActorFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ProcessReferencedOrderOrderStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedOrderOrderStatusEnumListFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumListFilter"},"ProcessReferencedOrderOrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedOrderOrderStatusEnumFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumFilter"},"ProcessReferencedPackJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobFilter","type":"object","description":"ProcessReferencedPackJobFilter"},"ProcessReferencedPackJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPackJobGlobalActorFilter","type":"object","description":"ProcessReferencedPackJobGlobalActorFilter"},"ProcessReferencedPackJobPackJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobPackJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumListFilter"},"ProcessReferencedPackJobPackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"ProcessReferencedPackJobPackJobStatusEnumFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumFilter"},"ProcessReferencedParcelFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelFilter","type":"object","description":"ProcessReferencedParcelFilter"},"ProcessReferencedParcelParcelStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelParcelStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumListFilter"},"ProcessReferencedParcelParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ProcessReferencedParcelParcelStatusEnumFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumFilter"},"ProcessReferencedParcelTrackingStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumFilter"}],"description":"Search by parcelTrackingStatus"}},"title":"ProcessReferencedParcelTrackingStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumListFilter"},"ProcessReferencedParcelTrackingStatusEnumFilter":{"properties":{"eq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"in":{"description":"Search by parcelTrackingStatus","items":{"enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"}},"title":"ProcessReferencedParcelTrackingStatusEnumFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumFilter"},"ProcessReferencedPickJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobFilter","type":"object","description":"ProcessReferencedPickJobFilter"},"ProcessReferencedPickJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPickJobGlobalActorFilter","type":"object","description":"ProcessReferencedPickJobGlobalActorFilter"},"ProcessReferencedPickJobPickJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobPickJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumListFilter"},"ProcessReferencedPickJobPickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"ProcessReferencedPickJobPickJobStatusEnumFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumFilter"},"ProcessReferencedReturnJobFilter":{"properties":{"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"returnFacilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by returnFacilityRefs"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobFilter","type":"object","description":"ProcessReferencedReturnJobFilter"},"ProcessReferencedReturnJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedReturnJobGlobalActorFilter","type":"object","description":"ProcessReferencedReturnJobGlobalActorFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"},"ProcessReferencedRoutingPlanFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanFilter","type":"object","description":"ProcessReferencedRoutingPlanFilter"},"ProcessReferencedRoutingPlanGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedRoutingPlanGlobalActorFilter","type":"object","description":"ProcessReferencedRoutingPlanGlobalActorFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"},"ProcessReferencedServiceJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobFilter","type":"object","description":"ProcessReferencedServiceJobFilter"},"ProcessReferencedServiceJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedServiceJobGlobalActorFilter","type":"object","description":"ProcessReferencedServiceJobGlobalActorFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumFilter"},"ProcessReferencedServiceLevelEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"ProcessReferencedServiceLevelEnumListFilter","type":"object","description":"ProcessReferencedServiceLevelEnumListFilter"},"ProcessReferencedServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"ProcessReferencedServiceLevelEnumFilter","type":"object","description":"ProcessReferencedServiceLevelEnumFilter"},"ProcessReferencedShipmentFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentFilter","type":"object","description":"ProcessReferencedShipmentFilter"},"ProcessReferencedShipmentShipmentStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentShipmentStatusEnumListFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumListFilter"},"ProcessReferencedShipmentShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedShipmentShipmentStatusEnumFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumFilter"},"ProcessReferencedStickerFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedStickerFilter","type":"object","description":"ProcessReferencedStickerFilter"},"SearchFilter":{"properties":{"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"}},"title":"SearchFilter","type":"object","description":"SearchFilter"},"ProcessTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ProcessTagsListFilter","type":"object","description":"ProcessTagsListFilter"},"ProcessTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ProcessTagsFilter","type":"object","description":"ProcessTagsFilter"},"ProcessSort":{"properties":{"activeFacilityCountry":{"enum":["ASC","DESC"],"type":"string"},"activeFacilityName":{"enum":["ASC","DESC"],"type":"string"},"created":{"enum":["ASC","DESC"],"type":"string"},"domsStatus":{"enum":["ASC","DESC"],"type":"string"},"inventoryStatus":{"enum":["ASC","DESC"],"type":"string"},"operativeStatus":{"enum":["ASC","DESC"],"type":"string"},"processId":{"enum":["ASC","DESC"],"type":"string"},"referenced":{"$ref":"#/components/schemas/ProcessReferencedSort"},"returnStatus":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessSort","type":"object","description":"ProcessSort"},"ProcessReferencedSort":{"properties":{"brand":{"$ref":"#/components/schemas/ProcessBrandSort"},"carrier":{"$ref":"#/components/schemas/ProcessCarrierSort"},"consumerAddress":{"$ref":"#/components/schemas/ProcessConsumerAddressSort"},"facility":{"$ref":"#/components/schemas/ProcessFacilitySort"},"order":{"$ref":"#/components/schemas/ProcessOrderSort"},"parcelTrackingStatus":{"enum":["ASC","DESC"],"type":"string"},"sticker":{"$ref":"#/components/schemas/ProcessStickerSort"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessReferencedSort","type":"object","description":"ProcessReferencedSort"},"ProcessBrandSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessBrandSort","type":"object","description":"ProcessBrandSort"},"ProcessCarrierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessCarrierSort","type":"object","description":"ProcessCarrierSort"},"ProcessConsumerAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessConsumerAddressSort","type":"object","description":"ProcessConsumerAddressSort"},"ProcessFacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/ProcessAddressSort"},"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessFacilitySort","type":"object","description":"ProcessFacilitySort"},"ProcessAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessAddressSort","type":"object","description":"ProcessAddressSort"},"ProcessOrderSort":{"properties":{"desiredDeliveryTime":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"orderedAmount":{"enum":["ASC","DESC"],"type":"string"},"provisioningTime":{"enum":["ASC","DESC"],"type":"string"},"tenantOrderId":{"enum":["ASC","DESC"],"type":"string"},"updateDetails":{"allOf":[{"$ref":"#/components/schemas/ProcessUpdateDetailsSort"}]}},"title":"ProcessOrderSort","type":"object","description":"ProcessOrderSort"},"ProcessUpdateDetailsSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"user":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessUpdateDetailsSort","type":"object","description":"ProcessUpdateDetailsSort"},"ProcessStickerSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessStickerSort","type":"object","description":"ProcessStickerSort"}}}}
```

## The ProcessSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ProcessSearchQuery"},"maxItems":500,"type":"array"},"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by carrierManagementStatuses"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by created"},"documentRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by documentRefs"},"domainStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesFilter"}],"description":"Nested search by domainStatuses"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by domsStatus"},"externalActionRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by externalActionRefs"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"facilityRefsWithActiveOperations":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRefsWithActiveOperations"},"flatRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by flatRefs"},"handoverJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by handoverJobRefs"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by inventoryStatus"},"itemReturnJobsRef":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by itemReturnJobsRef"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by operativeStatus"},"or":{"items":{"$ref":"#/components/schemas/ProcessSearchQuery"},"maxItems":500,"type":"array"},"orderRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by orderRef"},"packJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by packJobRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"processId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by processId"},"referenced":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFilter"}],"description":"Nested search by referenced"},"returnRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by returnRefs"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by returnStatus"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"searchTerm":{"allOf":[{"$ref":"#/components/schemas/SearchFilter"}],"description":"Full-text search for this entity"},"serviceJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by serviceJobRefs"},"shipmentRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by shipmentRefs"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by status"},"tags":{"allOf":[{"$ref":"#/components/schemas/ProcessTagsListFilter"}],"description":"Nested list search by tags"}},"title":"ProcessSearchQuery","type":"object","description":"ProcessSearchQuery"},"ProcessStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"}},"title":"ProcessStatusEnumFilter","type":"object","description":"ProcessStatusEnumFilter"},"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"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessDomainStatusesFilter":{"properties":{"handover":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by handover"},"order":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by order"},"packing":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by packing"},"picking":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by picking"},"return":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by return"},"routing":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by routing"},"service":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by service"},"shipping":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by shipping"}},"title":"ProcessDomainStatusesFilter","type":"object","description":"ProcessDomainStatusesFilter"},"ProcessDomainStatusesDomainStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumFilter"}],"description":"Search by order"}},"title":"ProcessDomainStatusesDomainStatusEnumListFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumListFilter"},"ProcessDomainStatusesDomainStatusEnumFilter":{"properties":{"eq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by order","items":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessDomainStatusesDomainStatusEnumFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumFilter"},"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"},"ProcessReferencedFilter":{"properties":{"brand":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedBrandFilter"}],"description":"Nested search by brand"},"carrier":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedCarrierFilter"}],"description":"Nested search by carrier"},"consumerAddress":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedConsumerAddressFilter"}],"description":"Nested search by consumerAddress"},"facility":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityFilter"}],"description":"Nested search by facility"},"handoverJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobFilter"}],"description":"Nested search by handoverJob"},"order":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderFilter"}],"description":"Nested search by order"},"packJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobFilter"}],"description":"Nested search by packJob"},"parcel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelFilter"}],"description":"Nested search by parcel"},"parcelTrackingStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumListFilter"}],"description":"Search by parcelTrackingStatus"},"pickJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobFilter"}],"description":"Nested search by pickJob"},"returnJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobFilter"}],"description":"Nested search by returnJob"},"routingPlan":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanFilter"}],"description":"Nested search by routingPlan"},"serviceJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobFilter"}],"description":"Nested search by serviceJob"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumListFilter"}],"description":"Search by serviceLevel"},"serviceType":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by serviceType"},"shipment":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentFilter"}],"description":"Nested search by shipment"},"sticker":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedStickerFilter"}],"description":"Nested search by sticker"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"}},"title":"ProcessReferencedFilter","type":"object","description":"ProcessReferencedFilter"},"ProcessReferencedBrandFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedBrandFilter","type":"object","description":"ProcessReferencedBrandFilter"},"ProcessReferencedCarrierFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by carrierTrackingNumber"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedCarrierFilter","type":"object","description":"ProcessReferencedCarrierFilter"},"ProcessReferencedConsumerAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"deliveryCountry":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by deliveryCountry"}},"title":"ProcessReferencedConsumerAddressFilter","type":"object","description":"ProcessReferencedConsumerAddressFilter"},"ProcessReferencedFacilityFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityAddressFilter"}],"description":"Nested search by address"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedFacilityFilter","type":"object","description":"ProcessReferencedFacilityFilter"},"ProcessReferencedFacilityAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"}},"title":"ProcessReferencedFacilityAddressFilter","type":"object","description":"ProcessReferencedFacilityAddressFilter"},"ProcessReferencedHandoverJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"pickupIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by pickupIdentifier"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobFilter","type":"object","description":"ProcessReferencedHandoverJobFilter"},"ProcessReferencedHandoverJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedHandoverJobGlobalActorFilter","type":"object","description":"ProcessReferencedHandoverJobGlobalActorFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter":{"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":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"},"ProcessReferencedOrderFilter":{"properties":{"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerId"},"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderGlobalActorFilter"}],"description":"Nested search by globalActor"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by orderDate"},"orderedAmount":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by orderedAmount"},"provisioningTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by provisioningTime"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumListFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"ProcessReferencedOrderFilter","type":"object","description":"ProcessReferencedOrderFilter"},"ProcessReferencedOrderGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedOrderGlobalActorFilter","type":"object","description":"ProcessReferencedOrderGlobalActorFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ProcessReferencedOrderOrderStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedOrderOrderStatusEnumListFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumListFilter"},"ProcessReferencedOrderOrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedOrderOrderStatusEnumFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumFilter"},"ProcessReferencedPackJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobFilter","type":"object","description":"ProcessReferencedPackJobFilter"},"ProcessReferencedPackJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPackJobGlobalActorFilter","type":"object","description":"ProcessReferencedPackJobGlobalActorFilter"},"ProcessReferencedPackJobPackJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobPackJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumListFilter"},"ProcessReferencedPackJobPackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"ProcessReferencedPackJobPackJobStatusEnumFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumFilter"},"ProcessReferencedParcelFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelFilter","type":"object","description":"ProcessReferencedParcelFilter"},"ProcessReferencedParcelParcelStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelParcelStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumListFilter"},"ProcessReferencedParcelParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ProcessReferencedParcelParcelStatusEnumFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumFilter"},"ProcessReferencedParcelTrackingStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumFilter"}],"description":"Search by parcelTrackingStatus"}},"title":"ProcessReferencedParcelTrackingStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumListFilter"},"ProcessReferencedParcelTrackingStatusEnumFilter":{"properties":{"eq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"in":{"description":"Search by parcelTrackingStatus","items":{"enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"}},"title":"ProcessReferencedParcelTrackingStatusEnumFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumFilter"},"ProcessReferencedPickJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobFilter","type":"object","description":"ProcessReferencedPickJobFilter"},"ProcessReferencedPickJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPickJobGlobalActorFilter","type":"object","description":"ProcessReferencedPickJobGlobalActorFilter"},"ProcessReferencedPickJobPickJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobPickJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumListFilter"},"ProcessReferencedPickJobPickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"ProcessReferencedPickJobPickJobStatusEnumFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumFilter"},"ProcessReferencedReturnJobFilter":{"properties":{"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"returnFacilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by returnFacilityRefs"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobFilter","type":"object","description":"ProcessReferencedReturnJobFilter"},"ProcessReferencedReturnJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedReturnJobGlobalActorFilter","type":"object","description":"ProcessReferencedReturnJobGlobalActorFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"},"ProcessReferencedRoutingPlanFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanFilter","type":"object","description":"ProcessReferencedRoutingPlanFilter"},"ProcessReferencedRoutingPlanGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedRoutingPlanGlobalActorFilter","type":"object","description":"ProcessReferencedRoutingPlanGlobalActorFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"},"ProcessReferencedServiceJobFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobFilter","type":"object","description":"ProcessReferencedServiceJobFilter"},"ProcessReferencedServiceJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedServiceJobGlobalActorFilter","type":"object","description":"ProcessReferencedServiceJobGlobalActorFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumFilter"},"ProcessReferencedServiceLevelEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"ProcessReferencedServiceLevelEnumListFilter","type":"object","description":"ProcessReferencedServiceLevelEnumListFilter"},"ProcessReferencedServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"ProcessReferencedServiceLevelEnumFilter","type":"object","description":"ProcessReferencedServiceLevelEnumFilter"},"ProcessReferencedShipmentFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentFilter","type":"object","description":"ProcessReferencedShipmentFilter"},"ProcessReferencedShipmentShipmentStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentShipmentStatusEnumListFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumListFilter"},"ProcessReferencedShipmentShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedShipmentShipmentStatusEnumFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumFilter"},"ProcessReferencedStickerFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedStickerFilter","type":"object","description":"ProcessReferencedStickerFilter"},"SearchFilter":{"properties":{"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"}},"title":"SearchFilter","type":"object","description":"SearchFilter"},"ProcessTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ProcessTagsListFilter","type":"object","description":"ProcessTagsListFilter"},"ProcessTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ProcessTagsFilter","type":"object","description":"ProcessTagsFilter"}}}}
```

## The ProcessSearchResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessSearchResult":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"id":{"type":"string"},"lastModified":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"processSearchResultEntities":{"type":"object"},"version":{"type":"integer"}},"required":["id","version","created","lastModified","processSearchResultEntities"],"title":"ProcessSearchResult","type":"object","description":"ProcessSearchResult"}}}}
```

## The ProcessSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessSort":{"properties":{"activeFacilityCountry":{"enum":["ASC","DESC"],"type":"string"},"activeFacilityName":{"enum":["ASC","DESC"],"type":"string"},"created":{"enum":["ASC","DESC"],"type":"string"},"domsStatus":{"enum":["ASC","DESC"],"type":"string"},"inventoryStatus":{"enum":["ASC","DESC"],"type":"string"},"operativeStatus":{"enum":["ASC","DESC"],"type":"string"},"processId":{"enum":["ASC","DESC"],"type":"string"},"referenced":{"$ref":"#/components/schemas/ProcessReferencedSort"},"returnStatus":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessSort","type":"object","description":"ProcessSort"},"ProcessReferencedSort":{"properties":{"brand":{"$ref":"#/components/schemas/ProcessBrandSort"},"carrier":{"$ref":"#/components/schemas/ProcessCarrierSort"},"consumerAddress":{"$ref":"#/components/schemas/ProcessConsumerAddressSort"},"facility":{"$ref":"#/components/schemas/ProcessFacilitySort"},"order":{"$ref":"#/components/schemas/ProcessOrderSort"},"parcelTrackingStatus":{"enum":["ASC","DESC"],"type":"string"},"sticker":{"$ref":"#/components/schemas/ProcessStickerSort"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessReferencedSort","type":"object","description":"ProcessReferencedSort"},"ProcessBrandSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessBrandSort","type":"object","description":"ProcessBrandSort"},"ProcessCarrierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessCarrierSort","type":"object","description":"ProcessCarrierSort"},"ProcessConsumerAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessConsumerAddressSort","type":"object","description":"ProcessConsumerAddressSort"},"ProcessFacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/ProcessAddressSort"},"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessFacilitySort","type":"object","description":"ProcessFacilitySort"},"ProcessAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessAddressSort","type":"object","description":"ProcessAddressSort"},"ProcessOrderSort":{"properties":{"desiredDeliveryTime":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"orderedAmount":{"enum":["ASC","DESC"],"type":"string"},"provisioningTime":{"enum":["ASC","DESC"],"type":"string"},"tenantOrderId":{"enum":["ASC","DESC"],"type":"string"},"updateDetails":{"allOf":[{"$ref":"#/components/schemas/ProcessUpdateDetailsSort"}]}},"title":"ProcessOrderSort","type":"object","description":"ProcessOrderSort"},"ProcessUpdateDetailsSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"user":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessUpdateDetailsSort","type":"object","description":"ProcessUpdateDetailsSort"},"ProcessStickerSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessStickerSort","type":"object","description":"ProcessStickerSort"}}}}
```

## The ProcessStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"}}}}
```

## The ProcessStatusDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"}}}}
```

## The ProcessStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"}},"title":"ProcessStatusEnumFilter","type":"object","description":"ProcessStatusEnumFilter"}}}}
```

## The ProcessStickerSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessStickerSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessStickerSort","type":"object","description":"ProcessStickerSort"}}}}
```

## The ProcessSubStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"}}}}
```

## The ProcessTagsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ProcessTagsFilter","type":"object","description":"ProcessTagsFilter"},"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"}}}}
```

## The ProcessTagsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ProcessTagsListFilter","type":"object","description":"ProcessTagsListFilter"},"ProcessTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ProcessTagsFilter","type":"object","description":"ProcessTagsFilter"},"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"}}}}
```

## The ProcessUpdateDetailsSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessUpdateDetailsSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"user":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessUpdateDetailsSort","type":"object","description":"ProcessUpdateDetailsSort"}}}}
```

## The ProcessWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Process"}},"required":["payload"],"type":"object","title":"ProcessWebHookEvent","description":"ProcessWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"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"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ProductInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProductInformation":{"properties":{"additionalShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"type":"array"},"additionalShippingAttributes":{"items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"type":"array"},"carrierCountryServiceMappingRef":{"description":"Id of the used CarrierCountryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"type":"array"},"mandatoryShippingItemAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","deprecated":true},"productName":{"description":"The name of the product used by the carrier","type":"string"}},"title":"ProductInformation","description":"ProductInformation"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"}}}}
```

## The ProductValueCurrency object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"}}}}
```

## The ProductValueType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"}}}}
```

## The PromiseCarrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PromiseCarrier":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"},"carrierRef":{"type":"string"},"deliveryPromiseValidUntil":{"format":"date-time","type":"string"},"products":{"items":{"$ref":"#/components/schemas/PromiseDeliveryOptions"},"type":"array"}},"required":["carrierRef","carrierKey","carrierName","products"],"type":"object","xml":{"name":"PromiseCarrier"},"title":"PromiseCarrier","description":"PromiseCarrier"},"PromiseDeliveryOptions":{"additionalProperties":false,"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"deliveryCosts":{"items":{"$ref":"#/components/schemas/DeliveryCost"},"type":"array"},"estimatedDeliveryTime":{"$ref":"#/components/schemas/EstimatedDeliveryTime"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"}},"required":["carrierProductCategory","deliveryCosts"],"type":"object","xml":{"name":"PromiseDeliveryOptions"},"title":"PromiseDeliveryOptions","description":"PromiseDeliveryOptions"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"EstimatedDeliveryTime":{"properties":{"maxDeliveryDays":{"description":"Maximum total delivery time in days","minimum":0,"type":"integer"},"minDeliveryDays":{"description":"Minimum total delivery time in days","minimum":0,"type":"integer"}},"required":["maxDeliveryDays","minDeliveryDays"],"type":"object","title":"EstimatedDeliveryTime","description":"EstimatedDeliveryTime"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The PromiseConfirmActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PromiseConfirmActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to confirm a promise.","properties":{"name":{"enum":["CONFIRM_PROMISE"],"type":"string"},"tenantOrderId":{"description":"The tenantOrderId to be used for the resulting order","type":"string"}},"required":["name","version"],"title":"PromiseConfirmActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"}}}}
```

## The PromiseDeliveryOptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PromiseDeliveryOptions":{"additionalProperties":false,"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"deliveryCosts":{"items":{"$ref":"#/components/schemas/DeliveryCost"},"type":"array"},"estimatedDeliveryTime":{"$ref":"#/components/schemas/EstimatedDeliveryTime"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"}},"required":["carrierProductCategory","deliveryCosts"],"type":"object","xml":{"name":"PromiseDeliveryOptions"},"title":"PromiseDeliveryOptions","description":"PromiseDeliveryOptions"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"EstimatedDeliveryTime":{"properties":{"maxDeliveryDays":{"description":"Maximum total delivery time in days","minimum":0,"type":"integer"},"minDeliveryDays":{"description":"Minimum total delivery time in days","minimum":0,"type":"integer"}},"required":["maxDeliveryDays","minDeliveryDays"],"type":"object","title":"EstimatedDeliveryTime","description":"EstimatedDeliveryTime"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The PromiseExtendActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PromiseExtendActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to extend a promise.","properties":{"name":{"enum":["EXTEND_PROMISE"],"type":"string"}},"required":["name","version"],"title":"PromiseExtendActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"}}}}
```

## The PromiseRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PromiseRequest":{"additionalProperties":false,"properties":{"additionalInfo":{"$ref":"#/components/schemas/PromiseRequestAdditionalInfo"},"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"$ref":"#/components/schemas/OrderPricingForCreation"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"xml":{"name":"PromiseRequest"},"title":"PromiseRequest","description":"PromiseRequest"},"PromiseRequestAdditionalInfo":{"properties":{"includeListingCustomAttributes":{"default":false,"description":"If true, the listing custom attributes are included in the response. This is useful for debugging purposes.","type":"boolean"},"resourceInvestment":{"$ref":"#/components/schemas/ResourceInvestment"}},"type":"object","title":"PromiseRequestAdditionalInfo","description":"PromiseRequestAdditionalInfo"},"ResourceInvestment":{"description":"How much resources should be invested during the optimization?","properties":{"level":{"description":"[abstract values]: how many resources should we invest in optimization. With a higher level the results will be better, nevertheless we need to invest more time for the optimization.","exclusiveMinimum":true,"maximum":1,"minimum":0,"type":"number"}},"required":["level"],"type":"object","title":"ResourceInvestment"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The PromiseRequestAdditionalInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PromiseRequestAdditionalInfo":{"properties":{"includeListingCustomAttributes":{"default":false,"description":"If true, the listing custom attributes are included in the response. This is useful for debugging purposes.","type":"boolean"},"resourceInvestment":{"$ref":"#/components/schemas/ResourceInvestment"}},"type":"object","title":"PromiseRequestAdditionalInfo","description":"PromiseRequestAdditionalInfo"},"ResourceInvestment":{"description":"How much resources should be invested during the optimization?","properties":{"level":{"description":"[abstract values]: how many resources should we invest in optimization. With a higher level the results will be better, nevertheless we need to invest more time for the optimization.","exclusiveMinimum":true,"maximum":1,"minimum":0,"type":"number"}},"required":["level"],"type":"object","title":"ResourceInvestment"}}}}
```

## The PromisesConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PromisesConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"},"invalidAfterTime":{"default":"PT8H","description":"Default amount of time in ISO 8601 duration format after which an promised order becomes invalid and is cancelled. The duration need to be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["invalidAfterTime"],"title":"PromisesConfiguration","description":"PromisesConfiguration"},"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"}}}}
```

## The ProvidedSection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProvidedSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"ProvidedSection","type":"object","description":"ProvidedSection"},"PickingOutcomeDiagnostic":{"properties":{"code":{"$ref":"#/components/schemas/DiagnosticCode"}},"required":["code"],"title":"PickingOutcomeDiagnostic","type":"object","description":"PickingOutcomeDiagnostic"},"DiagnosticCode":{"description":"Indicates the specific reason a picking diagnostic was raised.\n\nSTOCK_SHORT_PICK => The quantity picked from a partial stock location was below the requested quantity, while short-pick handling was enabled for this configuration.\n\nLINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was below the requested quantity.\n\nSTOCK_NOT_FOUND => The specified stock reference or tenant stock ID could not be found.\n\nINSUFFICIENT_STOCK => The target stock did not have enough available quantity to fulfill the request.","enum":["STOCK_SHORT_PICK","LINE_ITEM_SHORT_PICK","STOCK_NOT_FOUND","INSUFFICIENT_STOCK"],"type":"string","xml":{"name":"DiagnosticCode"},"title":"DiagnosticCode"}}}}
```

## The PurchaseOrder object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"}}}}
```

## The PurchaseOrderEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrderEventPayload":{"properties":{"canceled":{"type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}]},"requestedItems":{"items":{"$ref":"#/components/schemas/InboundLineItem"},"type":"array"},"status":{"type":"string"},"supplier":{"$ref":"#/components/schemas/PurchaseOrderSupplier"},"tenantInboundProcessId":{"type":"string"},"transfer":{"$ref":"#/components/schemas/PurchaseOrderTransfer"},"version":{"type":"number"}},"required":["id","orderDate","requestedDate","requestedItems","inboundProcessRef","facilityRef","created","lastModified","canceled","status","version"],"title":"PurchaseOrderEventPayload","type":"object","description":"PurchaseOrderEventPayload"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"PurchaseOrderSupplier":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"title":"PurchaseOrderSupplier","type":"object","description":"PurchaseOrderSupplier"},"PurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"PurchaseOrderTransfer","type":"object","description":"PurchaseOrderTransfer"}}}}
```

## The PurchaseOrderForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrderForCreation":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"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"},"facilityRef":{"minLength":1,"type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"}},"required":["orderDate","requestedDate","requestedItems","facilityRef"],"title":"PurchaseOrderForCreation","type":"object","description":"PurchaseOrderForCreation"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"}}}}
```

## The PurchaseOrderForPartialUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrderForPartialUpdate":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"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"},"orderDate":{"format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}]},"requestedItems":{"items":{"$ref":"#/components/schemas/InboundLineItem"},"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"version":{"type":"number"}},"required":["version"],"title":"PurchaseOrderForPartialUpdate","type":"object","description":"PurchaseOrderForPartialUpdate"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"}}}}
```

## The PurchaseOrderForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrderForUpdate":{"properties":{"cancelled":{"deprecated":true,"description":"This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.","type":"boolean"},"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"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","version"],"title":"PurchaseOrderForUpdate","type":"object","description":"PurchaseOrderForUpdate"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"}}}}
```

## The PurchaseOrderSupplier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrderSupplier":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"title":"PurchaseOrderSupplier","type":"object","description":"PurchaseOrderSupplier"}}}}
```

## The PurchaseOrderTransfer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"PurchaseOrderTransfer","type":"object","description":"PurchaseOrderTransfer"}}}}
```

## The PurchaseOrderWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrderWebHookEvent":{"properties":{"payload":{"$ref":"#/components/schemas/PurchaseOrderEventPayload"}},"required":["payload"],"title":"PurchaseOrderWebHookEvent","type":"object","description":"PurchaseOrderWebHookEvent"},"PurchaseOrderEventPayload":{"properties":{"canceled":{"type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}]},"requestedItems":{"items":{"$ref":"#/components/schemas/InboundLineItem"},"type":"array"},"status":{"type":"string"},"supplier":{"$ref":"#/components/schemas/PurchaseOrderSupplier"},"tenantInboundProcessId":{"type":"string"},"transfer":{"$ref":"#/components/schemas/PurchaseOrderTransfer"},"version":{"type":"number"}},"required":["id","orderDate","requestedDate","requestedItems","inboundProcessRef","facilityRef","created","lastModified","canceled","status","version"],"title":"PurchaseOrderEventPayload","type":"object","description":"PurchaseOrderEventPayload"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"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"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"PurchaseOrderSupplier":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"title":"PurchaseOrderSupplier","type":"object","description":"PurchaseOrderSupplier"},"PurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"PurchaseOrderTransfer","type":"object","description":"PurchaseOrderTransfer"}}}}
```

## The PurchasePrice object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchasePrice":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"The currency of the purchase price."},"decimalPlaces":{"description":"The number of decimal places for the purchase price.","type":"number"},"value":{"description":"The value of the purchase price.","type":"number"}},"required":["value","currency","decimalPlaces"],"title":"PurchasePrice","type":"object","description":"PurchasePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The PurchasePriceResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchasePriceResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the purchase prices."},"purchasePrices":{"description":"The calculated purchase prices for the target listing.","items":{"$ref":"#/components/schemas/CalculatedPurchasePrice"},"type":"array"}},"required":["purchasePrices","pageInfo"],"title":"PurchasePriceResult","type":"object","description":"PurchasePriceResult"},"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"},"CalculatedPurchasePrice":{"properties":{"discount":{"description":"The discount applied to the purchase price","oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"discountedPurchasePrice":{"allOf":[{"$ref":"#/components/schemas/PurchasePrice"}],"description":"Discounted purchase price for the listing."},"purchasePrice":{"allOf":[{"$ref":"#/components/schemas/PurchasePrice"}],"description":"purchase price information for the listing."},"supplierFacilityRef":{"description":"The reference of the supplier facility.","type":"string"}},"required":["supplierFacilityRef","purchasePrice","discountedPurchasePrice"],"title":"CalculatedPurchasePrice","type":"object","description":"CalculatedPurchasePrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PurchasePrice":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"The currency of the purchase price."},"decimalPlaces":{"description":"The number of decimal places for the purchase price.","type":"number"},"value":{"description":"The value of the purchase price.","type":"number"}},"required":["value","currency","decimalPlaces"],"title":"PurchasePrice","type":"object","description":"PurchasePrice"}}}}
```

## The Quantity object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"}}}}
```

## The Rating object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Rating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"id":{"description":"This value identifies this very instance of the rating. It is set automatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"}},"required":["name","active","implementation","maxPenalty","id"],"type":"object","title":"Rating"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"}}}}
```

## The RatingConfigurationType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"}}}}
```

## The RatingImplementation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"}}}}
```

## The RatingResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RatingResult":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"penalty":{"type":"number"},"routingStrategyNodeId":{"type":"string"},"type":{"description":"The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'","type":"string"}},"required":["penalty","id","type","routingStrategyNodeId","name"],"title":"RatingResult","description":"RatingResult"}}}}
```

## The RatingResultType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"}}}}
```

## The RatingStatistic object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RatingStatistic":{"properties":{"durationMs":{"description":"Duration in Milliseconds","type":"number"},"maxPenalty":{"type":"number"},"maxScore":{"type":"number"},"minScore":{"type":"number"},"name":{"type":"string"}},"required":["name","maxPenalty","durationMs"],"title":"RatingStatistic","description":"RatingStatistic"}}}}
```

## The ReactiveErrorReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReactiveErrorReason":{"enum":["BACKORDER_LISTING","PREORDER_LISTING"],"title":"ReactiveErrorReason","description":"ReactiveErrorReason"}}}}
```

## The ReassignmentInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReassignmentInformation":{"properties":{"reassignedItems":{"items":{"$ref":"#/components/schemas/AssignmentItem"},"type":"array"},"sourceFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"}},"required":["sourceFacility","reassignedItems"],"title":"ReassignmentInformation","description":"ReassignmentInformation"},"AssignmentItem":{"properties":{"articleTitle":{"type":"string"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"AssignmentItem","description":"AssignmentItem"},"DecisionLogFacilityInfo":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"required":["name","facilityRef"],"title":"DecisionLogFacilityInfo","description":"DecisionLogFacilityInfo"}}}}
```

## The Receipt object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"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"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The ReceiptForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReceiptForCreation":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"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"},"facilityRef":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForCreation"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","facilityRef"],"title":"ReceiptForCreation","type":"object","description":"ReceiptForCreation"},"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForCreation":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"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"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForCreation","type":"object","description":"InboundReceiptLineItemForCreation"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The RecommendationConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RecommendationConfiguration":{"properties":{"priceType":{"description":"Defines the price attribute category of which the price value is taken for carrier recommendation calculation","enum":["customs","insurance","shop","salesPrice","basePrice","tax"],"type":"string"}},"required":["priceType"],"title":"RecommendationConfiguration","type":"object","description":"RecommendationConfiguration"}}}}
```

## The RecommendedCarrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RecommendedCarrier":{"properties":{"carrierProduct":{"description":"Carrier product that has been selected.","type":"string"},"carrierRef":{"description":"Reference to the recommended carrier","type":"string"},"carrierServices":{"description":"Carrier services that have been selected","items":{"type":"string"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"RecommendedCarrier","type":"object","description":"RecommendedCarrier"}}}}
```

## The RecordableAttribute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RecordableAttributeForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RecordableAttributeForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ReductionSection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReductionSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"ReductionSection","type":"object","description":"ReductionSection"},"PickingOutcomeDiagnostic":{"properties":{"code":{"$ref":"#/components/schemas/DiagnosticCode"}},"required":["code"],"title":"PickingOutcomeDiagnostic","type":"object","description":"PickingOutcomeDiagnostic"},"DiagnosticCode":{"description":"Indicates the specific reason a picking diagnostic was raised.\n\nSTOCK_SHORT_PICK => The quantity picked from a partial stock location was below the requested quantity, while short-pick handling was enabled for this configuration.\n\nLINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was below the requested quantity.\n\nSTOCK_NOT_FOUND => The specified stock reference or tenant stock ID could not be found.\n\nINSUFFICIENT_STOCK => The target stock did not have enough available quantity to fulfill the request.","enum":["STOCK_SHORT_PICK","LINE_ITEM_SHORT_PICK","STOCK_NOT_FOUND","INSUFFICIENT_STOCK"],"type":"string","xml":{"name":"DiagnosticCode"},"title":"DiagnosticCode"}}}}
```

## The RefundTrigger object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RefundTrigger":{"properties":{"created":{"description":"Date when the refund was triggered","format":"date-time","type":"string"},"itemReturnJobRef":{"description":"reference to the item return job which is connected to the item return","type":"string"},"itemReturnJobVersion":{"description":"version of the item return job had during the refund trigger","type":"integer"},"itemReturnRef":{"description":"reference to the item return that should be refunded","type":"string"},"refundedLineItems":{"description":"The line items that should be refunded","items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"type":"array"},"returnFacilityRef":{"description":"The facility where the return was processed","type":"string"},"tenantOrderId":{"description":"The tenant order id of the order that should be refunded","maxLength":256,"minLength":1,"type":"string"}},"required":["created","refundedLineItems","returnFacilityRef","itemReturnRef"],"title":"RefundTrigger","type":"object","description":"RefundTrigger"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The RefundTriggeredWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RefundTriggeredWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/RefundTrigger"}},"required":["payload"],"type":"object","title":"RefundTriggeredWebHookEvent","description":"RefundTriggeredWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"RefundTrigger":{"properties":{"created":{"description":"Date when the refund was triggered","format":"date-time","type":"string"},"itemReturnJobRef":{"description":"reference to the item return job which is connected to the item return","type":"string"},"itemReturnJobVersion":{"description":"version of the item return job had during the refund trigger","type":"integer"},"itemReturnRef":{"description":"reference to the item return that should be refunded","type":"string"},"refundedLineItems":{"description":"The line items that should be refunded","items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"type":"array"},"returnFacilityRef":{"description":"The facility where the return was processed","type":"string"},"tenantOrderId":{"description":"The tenant order id of the order that should be refunded","maxLength":256,"minLength":1,"type":"string"}},"required":["created","refundedLineItems","returnFacilityRef","itemReturnRef"],"title":"RefundTrigger","type":"object","description":"RefundTrigger"},"ItemReturnLineItem":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["id","itemReturnJobLineItemRefs","tenantArticleId","status"],"title":"ItemReturnLineItem","type":"object","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The RefusedItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RefusedItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RegionInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"}}}}
```

## The RelatedRefs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"}}}}
```

## The RelativeSurchargeCostDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The RemoteConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfiguration":{"properties":{"created":{"description":"The date this entity was created at the platform","format":"date-time","type":"string"},"flattenScopeIds":{"description":"Generated flatten unique ids of all scope sub elements (userRef, facilityRef)","items":{"type":"string"},"type":"array"},"groups":{"description":"Groups this configuration belongs to","items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"id":{"description":"Auto generated unique identifier","type":"string"},"key":{"description":"Unique business key of this entity","type":"string"},"lastModified":{"description":"The date this entity was modified last","format":"date-time","type":"string"},"scopes":{"description":"Scopes for this remote configuration","items":{"$ref":"#/components/schemas/RemoteConfigurationScope"},"maxItems":20,"type":"array"},"value":{"description":"The value of this remote configuration","oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"valueType":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationValueType"}],"description":"The type of the value"},"version":{"description":"The version of the document for optimistic locking","type":"number"}},"required":["key","valueType","value","groups","id","version","flattenScopeIds"],"title":"RemoteConfiguration","type":"object","description":"RemoteConfiguration"},"RemoteConfigurationScope":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Auto generated unique identifier","type":"string"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id"],"title":"RemoteConfigurationScope","type":"object","description":"RemoteConfigurationScope"},"RemoteConfigurationValueType":{"description":"The type of the value","enum":["BOOLEAN","STRING","JSON","NUMBER","INT"],"title":"RemoteConfigurationValueType","type":"string"}}}}
```

## The RemoteConfigurationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationForCreation":{"properties":{"groups":{"description":"Groups this configuration belongs to","items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"key":{"description":"Unique business key of this entity","type":"string"},"scopes":{"description":"Scopes for this remote configuration","items":{"$ref":"#/components/schemas/RemoteConfigurationScopeForCreation"},"maxItems":20,"type":"array"},"value":{"description":"The value of this remote configuration","oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"valueType":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationValueType"}],"description":"The type of the value"}},"required":["key","valueType","value","groups"],"title":"RemoteConfigurationForCreation","type":"object","description":"RemoteConfigurationForCreation"},"RemoteConfigurationScopeForCreation":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"title":"RemoteConfigurationScopeForCreation","type":"object","description":"RemoteConfigurationScopeForCreation"},"RemoteConfigurationValueType":{"description":"The type of the value","enum":["BOOLEAN","STRING","JSON","NUMBER","INT"],"title":"RemoteConfigurationValueType","type":"string"}}}}
```

## The RemoteConfigurationForPut object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationForPut":{"properties":{"groups":{"description":"Groups this configuration belongs to","items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"scopes":{"description":"Scopes for this remote configuration","items":{"$ref":"#/components/schemas/RemoteConfigurationScopeForCreation"},"maxItems":20,"type":"array"},"value":{"description":"The value of this remote configuration","oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"valueType":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationValueType"}],"description":"The type of the value"},"version":{"description":"The version of the document for optimistic locking","type":"number"}},"required":["version","valueType","value","groups"],"title":"RemoteConfigurationForPut","type":"object","description":"RemoteConfigurationForPut"},"RemoteConfigurationScopeForCreation":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"title":"RemoteConfigurationScopeForCreation","type":"object","description":"RemoteConfigurationScopeForCreation"},"RemoteConfigurationValueType":{"description":"The type of the value","enum":["BOOLEAN","STRING","JSON","NUMBER","INT"],"title":"RemoteConfigurationValueType","type":"string"}}}}
```

## The RemoteConfigurationForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationForUpdate":{"properties":{"groups":{"description":"Groups this configuration belongs to","items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"scopes":{"description":"Scopes for this remote configuration","items":{"$ref":"#/components/schemas/RemoteConfigurationScopeForCreation"},"maxItems":20,"type":"array"},"value":{"description":"The value of this remote configuration","oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"valueType":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationValueType"}],"description":"The type of the value"},"version":{"description":"The version of the document for optimistic locking","type":"number"}},"required":["version"],"title":"RemoteConfigurationForUpdate","type":"object","description":"RemoteConfigurationForUpdate"},"RemoteConfigurationScopeForCreation":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"title":"RemoteConfigurationScopeForCreation","type":"object","description":"RemoteConfigurationScopeForCreation"},"RemoteConfigurationValueType":{"description":"The type of the value","enum":["BOOLEAN","STRING","JSON","NUMBER","INT"],"title":"RemoteConfigurationValueType","type":"string"}}}}
```

## The RemoteConfigurationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"remoteConfigurations":{"items":{"$ref":"#/components/schemas/RemoteConfiguration"},"type":"array"},"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","remoteConfigurations"],"title":"RemoteConfigurationPaginatedResult","type":"object","description":"RemoteConfigurationPaginatedResult"},"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"},"RemoteConfiguration":{"properties":{"created":{"description":"The date this entity was created at the platform","format":"date-time","type":"string"},"flattenScopeIds":{"description":"Generated flatten unique ids of all scope sub elements (userRef, facilityRef)","items":{"type":"string"},"type":"array"},"groups":{"description":"Groups this configuration belongs to","items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"id":{"description":"Auto generated unique identifier","type":"string"},"key":{"description":"Unique business key of this entity","type":"string"},"lastModified":{"description":"The date this entity was modified last","format":"date-time","type":"string"},"scopes":{"description":"Scopes for this remote configuration","items":{"$ref":"#/components/schemas/RemoteConfigurationScope"},"maxItems":20,"type":"array"},"value":{"description":"The value of this remote configuration","oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"valueType":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationValueType"}],"description":"The type of the value"},"version":{"description":"The version of the document for optimistic locking","type":"number"}},"required":["key","valueType","value","groups","id","version","flattenScopeIds"],"title":"RemoteConfiguration","type":"object","description":"RemoteConfiguration"},"RemoteConfigurationScope":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Auto generated unique identifier","type":"string"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id"],"title":"RemoteConfigurationScope","type":"object","description":"RemoteConfigurationScope"},"RemoteConfigurationValueType":{"description":"The type of the value","enum":["BOOLEAN","STRING","JSON","NUMBER","INT"],"title":"RemoteConfigurationValueType","type":"string"}}}}
```

## The RemoteConfigurations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurations":{"properties":{"remoteConfigurations":{"description":"Array of remote configurations","items":{"$ref":"#/components/schemas/RemoteConfiguration"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"number"}},"title":"RemoteConfigurations","type":"object","description":"RemoteConfigurations"},"RemoteConfiguration":{"properties":{"created":{"description":"The date this entity was created at the platform","format":"date-time","type":"string"},"flattenScopeIds":{"description":"Generated flatten unique ids of all scope sub elements (userRef, facilityRef)","items":{"type":"string"},"type":"array"},"groups":{"description":"Groups this configuration belongs to","items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"id":{"description":"Auto generated unique identifier","type":"string"},"key":{"description":"Unique business key of this entity","type":"string"},"lastModified":{"description":"The date this entity was modified last","format":"date-time","type":"string"},"scopes":{"description":"Scopes for this remote configuration","items":{"$ref":"#/components/schemas/RemoteConfigurationScope"},"maxItems":20,"type":"array"},"value":{"description":"The value of this remote configuration","oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"valueType":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationValueType"}],"description":"The type of the value"},"version":{"description":"The version of the document for optimistic locking","type":"number"}},"required":["key","valueType","value","groups","id","version","flattenScopeIds"],"title":"RemoteConfiguration","type":"object","description":"RemoteConfiguration"},"RemoteConfigurationScope":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Auto generated unique identifier","type":"string"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id"],"title":"RemoteConfigurationScope","type":"object","description":"RemoteConfigurationScope"},"RemoteConfigurationValueType":{"description":"The type of the value","enum":["BOOLEAN","STRING","JSON","NUMBER","INT"],"title":"RemoteConfigurationValueType","type":"string"}}}}
```

## The RemoteConfigurationScope object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationScope":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Auto generated unique identifier","type":"string"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["id"],"title":"RemoteConfigurationScope","type":"object","description":"RemoteConfigurationScope"}}}}
```

## The RemoteConfigurationScopeForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationScopeForCreation":{"properties":{"facilityRefs":{"description":"References of facilities this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"},"userRefs":{"description":"References of users this scope applies to","items":{"type":"string"},"maxItems":100,"type":"array"}},"title":"RemoteConfigurationScopeForCreation","type":"object","description":"RemoteConfigurationScopeForCreation"}}}}
```

## The RemoteConfigurationScopesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationScopesFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"userRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by userRefs"}},"title":"RemoteConfigurationScopesFilter","type":"object","description":"RemoteConfigurationScopesFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The RemoteConfigurationScopesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationScopesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationScopesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RemoteConfigurationScopesListFilter","type":"object","description":"RemoteConfigurationScopesListFilter"},"RemoteConfigurationScopesFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"userRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by userRefs"}},"title":"RemoteConfigurationScopesFilter","type":"object","description":"RemoteConfigurationScopesFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The RemoteConfigurationSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationSearchPayload":{"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/RemoteConfigurationSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"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":"RemoteConfigurationSearchPayload","type":"object","description":"RemoteConfigurationSearchPayload"},"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"},"RemoteConfigurationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/RemoteConfigurationSearchQuery"},"maxItems":500,"type":"array"},"groups":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by groups"},"key":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by key"},"or":{"items":{"$ref":"#/components/schemas/RemoteConfigurationSearchQuery"},"maxItems":500,"type":"array"},"scopes":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationScopesListFilter"}],"description":"Nested list search by scopes"}},"title":"RemoteConfigurationSearchQuery","type":"object","description":"RemoteConfigurationSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"RemoteConfigurationScopesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationScopesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RemoteConfigurationScopesListFilter","type":"object","description":"RemoteConfigurationScopesListFilter"},"RemoteConfigurationScopesFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"userRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by userRefs"}},"title":"RemoteConfigurationScopesFilter","type":"object","description":"RemoteConfigurationScopesFilter"}}}}
```

## The RemoteConfigurationSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/RemoteConfigurationSearchQuery"},"maxItems":500,"type":"array"},"groups":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by groups"},"key":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by key"},"or":{"items":{"$ref":"#/components/schemas/RemoteConfigurationSearchQuery"},"maxItems":500,"type":"array"},"scopes":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationScopesListFilter"}],"description":"Nested list search by scopes"}},"title":"RemoteConfigurationSearchQuery","type":"object","description":"RemoteConfigurationSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"RemoteConfigurationScopesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RemoteConfigurationScopesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RemoteConfigurationScopesListFilter","type":"object","description":"RemoteConfigurationScopesListFilter"},"RemoteConfigurationScopesFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"userRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by userRefs"}},"title":"RemoteConfigurationScopesFilter","type":"object","description":"RemoteConfigurationScopesFilter"}}}}
```

## The RemoteConfigurationValueType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoteConfigurationValueType":{"description":"The type of the value","enum":["BOOLEAN","STRING","JSON","NUMBER","INT"],"title":"RemoteConfigurationValueType","type":"string"}}}}
```

## The RemoveFacilitiesFromGroupActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoveFacilitiesFromGroupActionParameter":{"properties":{"facilitiesToRemove":{"description":"Array of facility references to remove from the group","items":{"type":"string"},"maxItems":200,"minItems":1,"type":"array"},"name":{"description":"The name of the action","enum":["REMOVE_FACILITIES_FROM_GROUP"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"number"}},"required":["facilitiesToRemove","name","version"],"title":"RemoveFacilitiesFromGroupActionParameter","type":"object","description":"RemoveFacilitiesFromGroupActionParameter"}}}}
```

## The RemoveFacilitiesFromGroupVersionlessActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoveFacilitiesFromGroupVersionlessActionParameter":{"properties":{"facilitiesToRemove":{"description":"Array of facility references to remove from the group","items":{"type":"string"},"maxItems":200,"minItems":1,"type":"array"},"name":{"description":"The name of the action","enum":["VERSIONLESS_REMOVE_FACILITIES_FROM_GROUP"],"type":"string"}},"required":["facilitiesToRemove","name"],"title":"RemoveFacilitiesFromGroupVersionlessActionParameter","type":"object","description":"RemoveFacilitiesFromGroupVersionlessActionParameter"}}}}
```

## The RemoveFacilityCoordinatesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoveFacilityCoordinatesActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractFacilityActionsParameter"}],"description":"Remove facility Coordinates.","properties":{"name":{"enum":["REMOVE_FACILITY_COORDINATES"],"type":"string"}},"required":["name","version"],"title":"RemoveFacilityCoordinatesActionParameter"},"AbstractFacilityActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractFacilityActionsParameter","description":"AbstractFacilityActionsParameter"}}}}
```

## The RemoveLineItemFromPackingTargetContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoveLineItemFromPackingTargetContainer":{"additionalProperties":false,"description":"Action to a remove a line item from a packing target container.","properties":{"action":{"description":"'Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead'","enum":["RemoveLineItemFromPackingTargetContainer"],"type":"string"},"lineItemRef":{"description":"Id of the PackLineItem you want to remove.","type":"string"}},"required":["action","lineItemRef"],"title":"RemoveLineItemFromPackingTargetContainer","type":"object","xml":{"name":"RemoveLineItemFromPackingTargetContainer"}}}}}
```

## The RemovePickJobFromPickRun object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemovePickJobFromPickRun":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'RemovePickJobFromPickRun', because you want to remove a pickjob","enum":["RemovePickJobFromPickRun"],"type":"string"},"pickJobRef":{"description":"PickJob reference of the PickJob you want to remove.","type":"string"}},"required":["action","pickJobRef"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use /api/pickruns/{pickRunId}/actions instead","title":"RemovePickJobFromPickRun","xml":{"name":"RemovePickJobFromPickRun"}}}}}
```

## The RemoveServiceDataAvailableLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RemoveServiceDataAvailableLineItemsActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'REMOVE_SERVICE_DATA_AVAILABLE_LINE_ITEMS'","enum":["REMOVE_SERVICE_DATA_AVAILABLE_LINE_ITEMS"],"type":"string"},"serviceDataAvailableLineItemIds":{"description":"Ids of the service data available line items to be removed","items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"serviceDataVersion":{"description":"Version of the service data","minimum":0,"type":"integer"}},"required":["name","serviceDataAvailableLineItemIds","serviceDataVersion"],"title":"RemoveServiceDataAvailableLineItemsActionParameter","type":"object","description":"RemoveServiceDataAvailableLineItemsActionParameter"}}}}
```

## The ReopenStowJobAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReopenStowJobAction":{"description":"Sets the status of the stowjob to OPEN","properties":{"name":{"description":"The name of the action that should be performed","enum":["OPEN_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"ReopenStowJobAction","type":"object"}}}}
```

## The ReplaceCodesInPackingTargetContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReplaceCodesInPackingTargetContainer":{"additionalProperties":false,"description":"Action to replace codes in packing target container.","properties":{"action":{"description":"Use ReplaceCodesInPackingTargetContainer to add a code to an existing packing container","enum":["ReplaceCodesInPackingTargetContainer"],"type":"string"},"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"}},"required":["action"],"title":"ReplaceCodesInPackingTargetContainer","type":"object","xml":{"name":"ReplaceCodesInPackingTargetContainer"}}}}}
```

## The ReplaceLineItemsOnItemReturnJobActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReplaceLineItemsOnItemReturnJobActionParameter":{"properties":{"name":{"enum":["REPLACE_LINE_ITEMS_ON_ITEM_RETURN_JOB"],"type":"string"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"},"maxItems":20,"minItems":0,"type":"array"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"},"maxItems":20,"minItems":0,"type":"array"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","name"],"title":"ReplaceLineItemsOnItemReturnJobActionParameter","type":"object","description":"ReplaceLineItemsOnItemReturnJobActionParameter"},"ItemReturnJobLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"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"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"maxItems":50,"type":"array"},"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","type":"object","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"prices":{"deprecated":true,"description":"Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"maxItems":50,"type":"array"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ItemReturnJobLineItemArticle","type":"object","description":"ItemReturnJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"}}}}
```

## The ReplaceLoadUnitLineItems object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReplaceLoadUnitLineItems":{"properties":{"action":{"description":"Use value 'ReplaceLoadUnitLineItems', because you want to replace load unit line items","enum":["ReplaceLoadUnitLineItems"],"type":"string"},"loadUnitLineItems":{"items":{"$ref":"#/components/schemas/LoadUnitLineItem"},"maxItems":100,"type":"array"}},"required":["action","loadUnitLineItems"],"title":"ReplaceLoadUnitLineItems","type":"object","description":"ReplaceLoadUnitLineItems"},"LoadUnitLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LoadUnitLineItemArticle"},"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"},"globalLineItemId":{"deprecated":true,"description":"Deprecated. Use globalLineItemIds instead.","type":"string"},"globalLineItemIds":{"description":"Global line item ids that refer to this line item","items":{"type":"string"},"maxItems":100,"type":"array"},"id":{"description":"Unique identifier for the line item","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":100,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":100,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article"],"title":"LoadUnitLineItem","type":"object","description":"LoadUnitLineItem"},"LoadUnitLineItemArticle":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":100,"type":"array"},"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":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"},"weight":{"type":"number"}},"required":["tenantArticleId","title"],"title":"LoadUnitLineItemArticle","type":"object","description":"LoadUnitLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The ReplacePackingTargetContainerLineItemCodesAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReplacePackingTargetContainerLineItemCodesAction":{"additionalProperties":false,"description":"Action to replace packing target container codes of a line item.","properties":{"name":{"$ref":"#/components/schemas/ReplacePackingTargetContainerLineItemCodesEnum"},"payload":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"}},"required":["codes"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["payload","version","name"],"title":"ReplacePackingTargetContainerLineItemCodesAction","type":"object"},"ReplacePackingTargetContainerLineItemCodesEnum":{"enum":["ReplaceLineItemCodes"],"type":"string","title":"ReplacePackingTargetContainerLineItemCodesEnum","description":"ReplacePackingTargetContainerLineItemCodesEnum"}}}}
```

## The ReplacePackingTargetContainerLineItemCodesEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReplacePackingTargetContainerLineItemCodesEnum":{"enum":["ReplaceLineItemCodes"],"type":"string","title":"ReplacePackingTargetContainerLineItemCodesEnum","description":"ReplacePackingTargetContainerLineItemCodesEnum"}}}}
```

## The ReplaceReturnedLineItems object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReplaceReturnedLineItems":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemForCreation"},"maxItems":100,"minItems":1,"type":"array"}},"required":["itemReturnJobVersion","returnedLineItems"],"title":"ReplaceReturnedLineItems","type":"object","description":"ReplaceReturnedLineItems"},"ItemReturnLineItemForCreation":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReasonForUpsert"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRef":{"description":"id of the item return job line item that is returned","type":"string"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["itemReturnJobLineItemRef","status"],"title":"ItemReturnLineItemForCreation","type":"object","description":"ItemReturnLineItemForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReasonForUpsert":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReasonForUpsert","type":"object","description":"ItemReturnLineItemReasonForUpsert"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"}}}}
```

## The ReplaceReturnedNotReturnableLineItems object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReplaceReturnedNotReturnableLineItems":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"returnedNotReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemForCreation"},"maxItems":100,"minItems":1,"type":"array"}},"required":["itemReturnJobVersion","returnedNotReturnableLineItems"],"title":"ReplaceReturnedNotReturnableLineItems","type":"object","description":"ReplaceReturnedNotReturnableLineItems"},"ItemReturnLineItemForCreation":{"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"decisionReason":{"$ref":"#/components/schemas/ItemReturnLineItemReasonForUpsert"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRef":{"description":"id of the item return job line item that is returned","type":"string"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"maxItems":20,"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"maxItems":50,"type":"array"},"status":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string"},"tenantArticleId":{"type":"string"}},"required":["itemReturnJobLineItemRef","status"],"title":"ItemReturnLineItemForCreation","type":"object","description":"ItemReturnLineItemForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReasonForUpsert":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReasonForUpsert","type":"object","description":"ItemReturnLineItemReasonForUpsert"},"ItemReturnLineItemReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","type":"object","description":"ItemReturnLineItemReason"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"}}}}
```

## The RequestedDate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"}}}}
```

## The RequestedDateASAP object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RequestedDateASAP":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"}},"required":["type"],"title":"RequestedDateASAP","type":"object","description":"RequestedDateASAP"}}}}
```

## The RequestedDateTimePoint object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RequestedDateTimePoint":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDateTimePoint","type":"object","description":"RequestedDateTimePoint"}}}}
```

## The RequestLabelAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RequestLabelAction":{"properties":{"name":{"description":"Identifier of the specified action.","type":"string"},"version":{"description":"Optimistic locking version","type":"integer"}},"required":["name","version"],"title":"RequestLabelAction","type":"object","description":"RequestLabelAction"}}}}
```

## The RequiredLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"}}}}
```

## The RequiredLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RequiredLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["article","quantity"],"title":"RequiredLineItemForCreation","type":"object","description":"RequiredLineItemForCreation"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The RerouteConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"}}}}
```

## The RerouteDescription object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The RerouteDescriptionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteDescriptionForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"}],"type":"object","xml":{"name":"RerouteDescriptionForCreation"},"title":"RerouteDescriptionForCreation","description":"RerouteDescriptionForCreation"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RerouteDescriptionForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteDescriptionForModification":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForModification"}],"type":"object","xml":{"name":"RerouteDescriptionForModification"},"title":"RerouteDescriptionForModification","description":"RerouteDescriptionForModification"},"AbstractReasonForModification":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForModification"},"title":"AbstractReasonForModification","description":"AbstractReasonForModification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RerouteDescriptionHistoryLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RerouteDescriptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteDescriptions":{"allOf":[{"$ref":"#/components/schemas/AbstractReasons"}],"properties":{"reasons":{"items":{"$ref":"#/components/schemas/RerouteDescription"},"type":"array"},"rerouteDescriptions":{"items":{"$ref":"#/components/schemas/RerouteDescription"},"type":"array"}},"required":["reasons","rerouteDescriptions"],"type":"object","title":"RerouteDescriptions","description":"RerouteDescriptions"},"AbstractReasons":{"properties":{"hasNextPage":{"description":"True if there are more results after the current page","type":"boolean"},"reasons":{"items":{"$ref":"#/components/schemas/AbstractReason"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"required":["reasons","hasNextPage","total"],"type":"object","xml":{"name":"AbstractReasons"},"title":"AbstractReasons","description":"AbstractReasons"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"}}}}
```

## The RerouteLogPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteLogPayload":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"},"targetFacility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"}},"required":["targetFacility"],"type":"object","title":"RerouteLogPayload","description":"RerouteLogPayload"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"}}}}
```

## The RerouteLogPayloadBase object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteLogPayloadBase":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"}},"type":"object","title":"RerouteLogPayloadBase","description":"RerouteLogPayloadBase"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RerouteReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"}}}}
```

## The RerouteRoutingPlan object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteRoutingPlan":{"properties":{"allReroutable":{"description":"if set to true every reroutable routing plan is rerouted. overrules every other identifier","type":"boolean"},"orderRefs":{"items":{"type":"string"},"maxItems":10,"type":"array"},"routingPlanIds":{"items":{"type":"string"},"maxItems":10,"type":"array"},"tenantOrderIds":{"items":{"type":"string"},"maxItems":10,"type":"array"}},"type":"object","title":"RerouteRoutingPlan","description":"RerouteRoutingPlan"}}}}
```

## The RerouteShortPickConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteShortPickConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"description":"Reroute ShortPick Configuration","properties":{"blacklistAssignedFacilities":{"default":false,"description":"Does not consider facilities which previously owned the pickjob during routing.","type":"boolean"},"clickAndCollectReroute":{"$ref":"#/components/schemas/ClickAndCollectRerouteConfiguration"},"id":{"type":"string"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"restowAfterMinutes":{"description":"The amount of minutes after which an automated restow is executed","type":"number"},"shipFromStoreReroute":{"$ref":"#/components/schemas/ShipFromStoreRerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreReroute"],"title":"RerouteShortPickConfiguration","type":"object"},"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"},"ClickAndCollectRerouteConfiguration":{"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RerouteType"}},"required":["active"],"type":"object","title":"ClickAndCollectRerouteConfiguration","description":"ClickAndCollectRerouteConfiguration"},"RerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The short picked line items will be moved to a new routing plan and rerouted","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RerouteType"},"ShipFromStoreRerouteConfiguration":{"properties":{"active":{"type":"boolean"},"allowManualReroute":{"default":false,"deprecated":true,"description":"@deprecated This config property is deprecated since 26/02/24. Use GlobalManualRerouteConfiguration instead.","type":"boolean"},"facilityWideRerouteOnShortPick":{"default":false,"type":"boolean"},"rerouteTargetTime":{"description":"Only pickJobs where the targetTime in not larger than now plus this number are rerouted","type":"number"},"rerouteType":{"$ref":"#/components/schemas/RerouteType"}},"required":["active","rerouteType"],"type":"object","title":"ShipFromStoreRerouteConfiguration","description":"ShipFromStoreRerouteConfiguration"}}}}
```

## The RerouteStartedJobsConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"}}}}
```

## The RerouteTimeTriggeredConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteTimeTriggeredConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"id":{"type":"string"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"title":"RerouteTimeTriggeredConfiguration","description":"RerouteTimeTriggeredConfiguration"},"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"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"}}}}
```

## The RerouteType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The short picked line items will be moved to a new routing plan and rerouted","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RerouteType"}}}}
```

## The Reservation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"}}}}
```

## The ReservationAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationAction":{"properties":{"name":{"description":"Which action to perform","enum":["REMOVE_RESERVATIONS_REDUCE_STOCKS","REMOVE_RESERVATIONS_KEEP_STOCKS"],"type":"string"},"reservationSelector":{"allOf":[{"$ref":"#/components/schemas/ReservationActionSelector"}],"minProperties":1}},"required":["name","reservationSelector"],"title":"ReservationAction","type":"object","description":"ReservationAction"},"ReservationActionSelector":{"properties":{"orderRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"reservationPredicate":{"$ref":"#/components/schemas/ReservationSearchQuery"},"reservationRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"tenantOrderIds":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"title":"ReservationActionSelector","type":"object","description":"ReservationActionSelector"},"ReservationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/ReservationRelatedRefsFilter"}],"description":"Nested search by relatedRefs"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"ReservationSearchQuery","type":"object","description":"ReservationSearchQuery"},"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"},"ReservationRelatedRefsFilter":{"properties":{"orderRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by orderRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"transferRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by transferRefs"}},"title":"ReservationRelatedRefsFilter","type":"object","description":"ReservationRelatedRefsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The ReservationActionResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationActionResult":{"properties":{"reservation":{"$ref":"#/components/schemas/StrippedReservation"},"status":{"enum":["DELETED"],"type":"string"},"stockOperations":{"items":{"$ref":"#/components/schemas/ReservationActionStockOperation"},"type":"array"}},"required":["status","reservation"],"title":"ReservationActionResult","type":"object","description":"ReservationActionResult"},"StrippedReservation":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"StrippedReservation","type":"object","description":"StrippedReservation"},"ReservationActionStockOperation":{"properties":{"status":{"enum":["REDUCED","DELETED"],"type":"string"},"stock":{"$ref":"#/components/schemas/ReservationStock"}},"required":["status","stock"],"title":"ReservationActionStockOperation","type":"object","description":"ReservationActionStockOperation"},"ReservationStock":{"properties":{"id":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"title":"ReservationStock","type":"object","description":"ReservationStock"}}}}
```

## The ReservationActionSelector object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationActionSelector":{"properties":{"orderRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"reservationPredicate":{"$ref":"#/components/schemas/ReservationSearchQuery"},"reservationRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"tenantOrderIds":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"title":"ReservationActionSelector","type":"object","description":"ReservationActionSelector"},"ReservationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/ReservationRelatedRefsFilter"}],"description":"Nested search by relatedRefs"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"ReservationSearchQuery","type":"object","description":"ReservationSearchQuery"},"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"},"ReservationRelatedRefsFilter":{"properties":{"orderRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by orderRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"transferRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by transferRefs"}},"title":"ReservationRelatedRefsFilter","type":"object","description":"ReservationRelatedRefsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The ReservationActionStockOperation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationActionStockOperation":{"properties":{"status":{"enum":["REDUCED","DELETED"],"type":"string"},"stock":{"$ref":"#/components/schemas/ReservationStock"}},"required":["status","stock"],"title":"ReservationActionStockOperation","type":"object","description":"ReservationActionStockOperation"},"ReservationStock":{"properties":{"id":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"title":"ReservationStock","type":"object","description":"ReservationStock"}}}}
```

## The ReservationHost object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"}}}}
```

## The ReservationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"reservations":{"items":{"$ref":"#/components/schemas/Reservation"},"type":"array"},"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","reservations"],"title":"ReservationPaginatedResult","type":"object","description":"ReservationPaginatedResult"},"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"},"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"}}}}
```

## The ReservationRelatedRefsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationRelatedRefsFilter":{"properties":{"orderRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by orderRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"transferRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by transferRefs"}},"title":"ReservationRelatedRefsFilter","type":"object","description":"ReservationRelatedRefsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The ReservationReleaseCompletionEntityEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationReleaseCompletionEntityEnum":{"enum":["HANDOVERJOB","PICKJOB"],"type":"string","title":"ReservationReleaseCompletionEntityEnum","description":"ReservationReleaseCompletionEntityEnum"}}}}
```

## The ReservationsBulkWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationsBulkWebHookEvent":{"properties":{"payload":{"$ref":"#/components/schemas/ReservationsBulkWebHookEventPayload"}},"required":["payload"],"title":"ReservationsBulkWebHookEvent","type":"object","description":"ReservationsBulkWebHookEvent"},"ReservationsBulkWebHookEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Reservation"},"type":"array"}},"required":["items"],"title":"ReservationsBulkWebHookEventPayload","type":"object","description":"ReservationsBulkWebHookEventPayload"},"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"}}}}
```

## The ReservationsBulkWebHookEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationsBulkWebHookEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Reservation"},"type":"array"}},"required":["items"],"title":"ReservationsBulkWebHookEventPayload","type":"object","description":"ReservationsBulkWebHookEventPayload"},"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"}}}}
```

## The ReservationSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationSearchPayload":{"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/ReservationSearchQuery"},"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/ReservationSort"},"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":"ReservationSearchPayload","type":"object","description":"ReservationSearchPayload"},"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"},"ReservationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/ReservationRelatedRefsFilter"}],"description":"Nested search by relatedRefs"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"ReservationSearchQuery","type":"object","description":"ReservationSearchQuery"},"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"},"ReservationRelatedRefsFilter":{"properties":{"orderRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by orderRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"transferRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by transferRefs"}},"title":"ReservationRelatedRefsFilter","type":"object","description":"ReservationRelatedRefsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ReservationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ReservationSort","type":"object","description":"ReservationSort"}}}}
```

## The ReservationSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/ReservationRelatedRefsFilter"}],"description":"Nested search by relatedRefs"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"ReservationSearchQuery","type":"object","description":"ReservationSearchQuery"},"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"},"ReservationRelatedRefsFilter":{"properties":{"orderRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by orderRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"transferRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by transferRefs"}},"title":"ReservationRelatedRefsFilter","type":"object","description":"ReservationRelatedRefsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The ReservationSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ReservationSort","type":"object","description":"ReservationSort"}}}}
```

## The ReservationsPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationsPaginatedResult":{"properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"reservations":{"items":{"$ref":"#/components/schemas/Reservation"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","pageInfo","reservations"],"title":"ReservationsPaginatedResult","type":"object","description":"ReservationsPaginatedResult"},"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"},"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"}}}}
```

## The ReservationStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReservationStock":{"properties":{"id":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"title":"ReservationStock","type":"object","description":"ReservationStock"}}}}
```

## The ResetPickJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ResetPickJob":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ResetPickJob' to reset the pickJob and set it back to status OPEN and reset the pick line items.","enum":["ResetPickJob"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickjobs/:id/actions instead","title":"ResetPickJob","xml":{"name":"ResetPickJob"}}}}}
```

## The ResolvedSubstitutes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ResolvedSubstitutes":{"properties":{"substitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"tenantArticleId":{"type":"string"}},"required":["substitutes","tenantArticleId"],"type":"object","xml":{"name":"ResolvedSubstitutes"},"title":"ResolvedSubstitutes","description":"ResolvedSubstitutes"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"}}}}
```

## The ResourceInvestment object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ResourceInvestment":{"description":"How much resources should be invested during the optimization?","properties":{"level":{"description":"[abstract values]: how many resources should we invest in optimization. With a higher level the results will be better, nevertheless we need to invest more time for the optimization.","exclusiveMinimum":true,"maximum":1,"minimum":0,"type":"number"}},"required":["level"],"type":"object","title":"ResourceInvestment"}}}}
```

## The ResponseForCNCCheckoutOptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ResponseForCNCCheckoutOptions":{"properties":{"facilities":{"description":"Facilities offering Click & Collect (CNC)","items":{"$ref":"#/components/schemas/CheckoutOptionsFacilityForCNC"},"type":"array"}},"required":["facilities"],"title":"ResponseForCNCCheckoutOptions","type":"object","description":"ResponseForCNCCheckoutOptions"},"CheckoutOptionsFacilityForCNC":{"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"availabilities":{"description":"Article availabilities","items":{"$ref":"#/components/schemas/CheckoutOptionsAvailability"},"type":"array"},"closingDays":{"items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"customServices":{"description":"Custom services","items":{"$ref":"#/components/schemas/CheckoutOptionsCustomServices"},"type":"array"},"facilityRef":{"description":"Facility reference","type":"string"},"name":{"description":"Facility name","type":"string"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes"},"targetTime":{"description":"Target time for collection","format":"date-time","type":"string"}},"required":["facilityRef","name","address","closingDays","pickingTimes","availabilities","customServices","targetTime"],"title":"CheckoutOptionsFacilityForCNC","type":"object","description":"CheckoutOptionsFacilityForCNC"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CheckoutOptionsAvailability":{"properties":{"available":{"description":"Available quantity","type":"number"},"carrier":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsAvailabilityCarrier"}],"description":"Carrier details"},"isBackOrderable":{"description":"Is item back-orderable","type":"boolean"},"latestPickingStart":{"description":"Latest picking start","format":"date-time","type":"string"},"preOrderReleaseDate":{"description":"Pre-order release date","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","available","isBackOrderable"],"title":"CheckoutOptionsAvailability","type":"object","description":"CheckoutOptionsAvailability"},"CheckoutOptionsAvailabilityCarrier":{"properties":{"carrierProductCategory":{"description":"Carrier product category","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierRef":{"description":"Carrier reference","type":"string"}},"required":["carrierRef"],"title":"CheckoutOptionsAvailabilityCarrier","type":"object","description":"CheckoutOptionsAvailabilityCarrier"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"CheckoutOptionsCustomServices":{"properties":{"customServiceRef":{"description":"Custom service reference","type":"string"},"name":{"description":"Custom service name","type":"string"}},"required":["customServiceRef","name"],"title":"CheckoutOptionsCustomServices","type":"object","description":"CheckoutOptionsCustomServices"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"}}}}
```

## The ResponseForDeliveryPromise object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ResponseForDeliveryPromise":{"additionalProperties":false,"properties":{"backOrdered":{"$ref":"#/components/schemas/Backordered"},"collect":{"$ref":"#/components/schemas/DeliveryPromiseCollect"},"orderRef":{"type":"string"},"orderVersion":{"type":"number"},"pricing":{"$ref":"#/components/schemas/OrderPricing"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"shipToCustomer":{"items":{"$ref":"#/components/schemas/DeliveryPromiseShipment"},"type":"array"},"shipToStore":{"items":{"$ref":"#/components/schemas/DeliveryPromiseShipment"},"type":"array"},"sourcingOption":{"$ref":"#/components/schemas/SourcingOption"}},"required":["orderRef","orderVersion"],"type":"object","xml":{"name":"ResponseForDeliveryPromise"},"title":"ResponseForDeliveryPromise","description":"ResponseForDeliveryPromise"},"Backordered":{"properties":{"lineItems":{"items":{"$ref":"#/components/schemas/DeliveryPromiseLineItem"},"type":"array"}},"required":["lineItems"],"type":"object","title":"Backordered","description":"Backordered"},"DeliveryPromiseLineItem":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DeliveryPromiseLineItem","description":"DeliveryPromiseLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"DeliveryPromiseCollect":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BasicDeliveryPromiseShipment"}],"properties":{"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","xml":{"name":"DeliveryPromiseCollect"},"title":"DeliveryPromiseCollect","description":"DeliveryPromiseCollect"},"BasicDeliveryPromiseShipment":{"additionalProperties":false,"properties":{"facility":{"$ref":"#/components/schemas/BasicDeliveryPromiseShipmentFacility"},"lineItems":{"items":{"$ref":"#/components/schemas/DeliveryPromiseLineItem"},"type":"array"}},"required":["lineItems","facility"],"type":"object","xml":{"name":"DeliveryPromiseShipment"},"title":"BasicDeliveryPromiseShipment","description":"BasicDeliveryPromiseShipment"},"BasicDeliveryPromiseShipmentFacility":{"additionalProperties":false,"properties":{"facilityName":{"type":"string"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityName","facilityRef"],"title":"BasicDeliveryPromiseShipmentFacility","description":"BasicDeliveryPromiseShipmentFacility"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"DeliveryPromiseShipment":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BasicDeliveryPromiseShipment"}],"properties":{"carriers":{"items":{"$ref":"#/components/schemas/PromiseCarrier"},"type":"array"}},"required":["carriers"],"type":"object","xml":{"name":"DeliveryPromiseShipment"},"title":"DeliveryPromiseShipment","description":"DeliveryPromiseShipment"},"PromiseCarrier":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"},"carrierRef":{"type":"string"},"deliveryPromiseValidUntil":{"format":"date-time","type":"string"},"products":{"items":{"$ref":"#/components/schemas/PromiseDeliveryOptions"},"type":"array"}},"required":["carrierRef","carrierKey","carrierName","products"],"type":"object","xml":{"name":"PromiseCarrier"},"title":"PromiseCarrier","description":"PromiseCarrier"},"PromiseDeliveryOptions":{"additionalProperties":false,"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"deliveryCosts":{"items":{"$ref":"#/components/schemas/DeliveryCost"},"type":"array"},"estimatedDeliveryTime":{"$ref":"#/components/schemas/EstimatedDeliveryTime"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"}},"required":["carrierProductCategory","deliveryCosts"],"type":"object","xml":{"name":"PromiseDeliveryOptions"},"title":"PromiseDeliveryOptions","description":"PromiseDeliveryOptions"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"EstimatedDeliveryTime":{"properties":{"maxDeliveryDays":{"description":"Maximum total delivery time in days","minimum":0,"type":"integer"},"minDeliveryDays":{"description":"Minimum total delivery time in days","minimum":0,"type":"integer"}},"required":["maxDeliveryDays","minDeliveryDays"],"type":"object","title":"EstimatedDeliveryTime","description":"EstimatedDeliveryTime"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"SourcingOption":{"properties":{"estimatedDeliveryDate":{"description":"Estimated delivery date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"estimatedPickupDate":{"description":"Estimated pickup date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"id":{"type":"string"},"listingDetails":{"items":{"$ref":"#/components/schemas/SourcingOptionListingDetails"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/SourcingOptionNode"},"type":"array"},"nonAssignedOrderLineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"priorityRatingResults":{"items":{"$ref":"#/components/schemas/PriorityRatingResult"},"type":"array"},"ratingResults":{"items":{"$ref":"#/components/schemas/RatingResult"},"type":"array"},"runId":{"type":"string"},"totalCosts":{"$ref":"#/components/schemas/SourcingOptionCosts"},"totalPenalty":{"description":"The total calculated penalty we calculated for this option","type":"number"},"transfers":{"items":{"$ref":"#/components/schemas/SourcingOptionTransfer"},"type":"array"},"validUntil":{"description":"The latest date at which this option is still valid, as an ISO8601 UTC timestamp string.","type":"string"}},"required":["id","runId","totalPenalty","nodes","transfers","ratingResults","priorityRatingResults"],"type":"object","title":"SourcingOption","description":"SourcingOption"},"SourcingOptionListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"type":"object"},"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"}},"title":"SourcingOptionListingDetails","description":"SourcingOptionListingDetails"},"SourcingOptionNode":{"properties":{"facilityRef":{"type":"string"},"id":{"description":"id of this node, unique for this Sourcing Option Responses","type":"string"},"isPickUpLocation":{"description":"Indicates if this node is a pick up location","type":"boolean"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"tenantFacilityId":{"type":"string"},"type":{"$ref":"#/components/schemas/NodeType"}},"required":["id","type","lineItems"],"type":"object","title":"SourcingOptionNode","description":"SourcingOptionNode"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"},"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"},"PriorityRatingResult":{"properties":{"id":{"type":"string"},"matchesPriorityMinimum":{"type":"boolean"},"name":{"type":"string"},"routingStrategyNodeId":{"type":"string"},"type":{"$ref":"#/components/schemas/RatingResultType"}},"required":["id","type","routingStrategyNodeId","matchesPriorityMinimum"],"title":"PriorityRatingResult","description":"PriorityRatingResult"},"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"},"RatingResult":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"penalty":{"type":"number"},"routingStrategyNodeId":{"type":"string"},"type":{"description":"The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'","type":"string"}},"required":["penalty","id","type","routingStrategyNodeId","name"],"title":"RatingResult","description":"RatingResult"},"SourcingOptionCosts":{"additionalProperties":false,"properties":{"salesPrices":{"description":"Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.","items":{"$ref":"#/components/schemas/SourcingOptionSalesPrice"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money"},"totalSalesPriceAmount":{"$ref":"#/components/schemas/Money"},"totalShippingCosts":{"$ref":"#/components/schemas/ShippingCosts"}},"required":["salesPrices"],"type":"object","title":"SourcingOptionCosts","description":"SourcingOptionCosts"},"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"SourcingOptionTransfer":{"properties":{"carrier":{"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"}},"type":"object"},"costDetails":{"description":"The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"existenceReason":{"$ref":"#/components/schemas/SourcingOptionTransferExistenceReason"},"facilityConnectionRef":{"type":"string"},"fallbackCosts":{"$ref":"#/components/schemas/Money"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"packagingInformation":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingInformation"},"type":"array"},"sourceNodeRef":{"type":"string"},"strandId":{"type":"string"},"targetNodeRef":{"type":"string"},"timeLine":{"$ref":"#/components/schemas/TransferTimeLine"},"totalCosts":{"$ref":"#/components/schemas/Money"},"transferGroup":{"description":"The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.","type":"string"}},"required":["sourceNodeRef","targetNodeRef","lineItems","packagingInformation"],"type":"object","title":"SourcingOptionTransfer","description":"SourcingOptionTransfer"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"},"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"}}}}
```

## The ResponseForSFSCheckoutOptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ResponseForSFSCheckoutOptions":{"properties":{"facilities":{"description":"Facilities offering Ship From Store (SFS)","items":{"$ref":"#/components/schemas/CheckoutOptionsFacilityForSFS"},"type":"array"}},"required":["facilities"],"title":"ResponseForSFSCheckoutOptions","type":"object","description":"ResponseForSFSCheckoutOptions"},"CheckoutOptionsFacilityForSFS":{"properties":{"availabilities":{"description":"Article availabilities","items":{"$ref":"#/components/schemas/CheckoutOptionsAvailability"},"type":"array"},"customServices":{"description":"Custom services","items":{"$ref":"#/components/schemas/CheckoutOptionsCustomServices"},"type":"array"},"deliveryOptions":{"items":{"$ref":"#/components/schemas/PromiseCarrier"},"type":"array"},"facilityRef":{"description":"Facility reference","type":"string"},"name":{"description":"Facility name","type":"string"}},"required":["facilityRef","name","availabilities","deliveryOptions","customServices"],"title":"CheckoutOptionsFacilityForSFS","type":"object","description":"CheckoutOptionsFacilityForSFS"},"CheckoutOptionsAvailability":{"properties":{"available":{"description":"Available quantity","type":"number"},"carrier":{"allOf":[{"$ref":"#/components/schemas/CheckoutOptionsAvailabilityCarrier"}],"description":"Carrier details"},"isBackOrderable":{"description":"Is item back-orderable","type":"boolean"},"latestPickingStart":{"description":"Latest picking start","format":"date-time","type":"string"},"preOrderReleaseDate":{"description":"Pre-order release date","format":"date-time","type":"string"},"tenantArticleId":{"description":"Tenant article ID","type":"string"}},"required":["tenantArticleId","available","isBackOrderable"],"title":"CheckoutOptionsAvailability","type":"object","description":"CheckoutOptionsAvailability"},"CheckoutOptionsAvailabilityCarrier":{"properties":{"carrierProductCategory":{"description":"Carrier product category","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierRef":{"description":"Carrier reference","type":"string"}},"required":["carrierRef"],"title":"CheckoutOptionsAvailabilityCarrier","type":"object","description":"CheckoutOptionsAvailabilityCarrier"},"CheckoutOptionsCustomServices":{"properties":{"customServiceRef":{"description":"Custom service reference","type":"string"},"name":{"description":"Custom service name","type":"string"}},"required":["customServiceRef","name"],"title":"CheckoutOptionsCustomServices","type":"object","description":"CheckoutOptionsCustomServices"},"PromiseCarrier":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"},"carrierRef":{"type":"string"},"deliveryPromiseValidUntil":{"format":"date-time","type":"string"},"products":{"items":{"$ref":"#/components/schemas/PromiseDeliveryOptions"},"type":"array"}},"required":["carrierRef","carrierKey","carrierName","products"],"type":"object","xml":{"name":"PromiseCarrier"},"title":"PromiseCarrier","description":"PromiseCarrier"},"PromiseDeliveryOptions":{"additionalProperties":false,"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"deliveryCosts":{"items":{"$ref":"#/components/schemas/DeliveryCost"},"type":"array"},"estimatedDeliveryTime":{"$ref":"#/components/schemas/EstimatedDeliveryTime"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"}},"required":["carrierProductCategory","deliveryCosts"],"type":"object","xml":{"name":"PromiseDeliveryOptions"},"title":"PromiseDeliveryOptions","description":"PromiseDeliveryOptions"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"EstimatedDeliveryTime":{"properties":{"maxDeliveryDays":{"description":"Maximum total delivery time in days","minimum":0,"type":"integer"},"minDeliveryDays":{"description":"Minimum total delivery time in days","minimum":0,"type":"integer"}},"required":["maxDeliveryDays","minDeliveryDays"],"type":"object","title":"EstimatedDeliveryTime","description":"EstimatedDeliveryTime"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"}}}}
```

## The RestartItemReturnJobActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestartItemReturnJobActionParameter":{"properties":{"name":{"enum":["RestartItemReturnJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","name"],"title":"RestartItemReturnJobActionParameter","type":"object","description":"RestartItemReturnJobActionParameter"}}}}
```

## The RestartPickJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestartPickJob":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'RestartPickJob' to restart the pickJob and set it back to status IN_PROGRESS.","enum":["RestartPickJob"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickjobs/:id/actions instead","title":"RestartPickJob","xml":{"name":"RestartPickJob"}}}}}
```

## The RestartPickJobConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestartPickJobConfiguration":{"properties":{"active":{"default":true,"type":"boolean"}},"required":["active"],"type":"object","title":"RestartPickJobConfiguration","description":"RestartPickJobConfiguration"}}}}
```

## The RestowAttributeItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"RestowAttributeItem","description":"RestowAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The RestowedItems object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowedItems":{"properties":{"restowedItems":{"items":{"$ref":"#/components/schemas/RestowItem"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"RestowedItems","description":"RestowedItems"},"RestowItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"article":{"$ref":"#/components/schemas/RestowItemArticle"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"type":"string"},"location":{"$ref":"#/components/schemas/Location"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"operativeProcessRef":{"description":"id of the connected operative process if available","type":"string"},"processRef":{"description":"id of the connected process if available","type":"string"},"quantity":{"default":1,"format":"int64","minimum":1,"type":"integer"},"restowed":{"default":false,"description":"Indicates if the restowItem has been restowed","type":"boolean"},"status":{"$ref":"#/components/schemas/RestowItemStatus"},"stockRef":{"description":"id of the stock entity for this line item","type":"string"}},"required":["id","article","restowed","facilityRef","quantity","status"],"type":"object","title":"RestowItem","description":"RestowItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"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"},"RestowItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/RestowAttributeItem"},"type":"array"}},"type":"object"}],"xml":{"name":"RestowItemArticle"},"title":"RestowItemArticle","description":"RestowItemArticle"},"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. Ensure that no authentication is needed 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"},"RestowAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"RestowAttributeItem","description":"RestowAttributeItem"},"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"},"RestowItemStatus":{"description":"Status of the restow item","enum":["CANCELED","CLOSED","OPEN"],"type":"string","title":"RestowItemStatus"}}}}
```

## The RestowingProcessConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowingProcessConfiguration":{"properties":{"restowingProcessTypes":{"items":{"$ref":"#/components/schemas/RestowingProcessTypeEnum"},"minItems":0,"type":"array"}},"required":["restowingProcessTypes"],"type":"object","title":"RestowingProcessConfiguration","description":"RestowingProcessConfiguration"},"RestowingProcessTypeEnum":{"description":"Where restow items should be created during the operational process","enum":["PICKING","PACKING","HANDOVER"],"type":"string","title":"RestowingProcessTypeEnum"}}}}
```

## The RestowingProcessTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowingProcessTypeEnum":{"description":"Where restow items should be created during the operational process","enum":["PICKING","PACKING","HANDOVER"],"type":"string","title":"RestowingProcessTypeEnum"}}}}
```

## The RestowItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"article":{"$ref":"#/components/schemas/RestowItemArticle"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"type":"string"},"location":{"$ref":"#/components/schemas/Location"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"operativeProcessRef":{"description":"id of the connected operative process if available","type":"string"},"processRef":{"description":"id of the connected process if available","type":"string"},"quantity":{"default":1,"format":"int64","minimum":1,"type":"integer"},"restowed":{"default":false,"description":"Indicates if the restowItem has been restowed","type":"boolean"},"status":{"$ref":"#/components/schemas/RestowItemStatus"},"stockRef":{"description":"id of the stock entity for this line item","type":"string"}},"required":["id","article","restowed","facilityRef","quantity","status"],"type":"object","title":"RestowItem","description":"RestowItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"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"},"RestowItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/RestowAttributeItem"},"type":"array"}},"type":"object"}],"xml":{"name":"RestowItemArticle"},"title":"RestowItemArticle","description":"RestowItemArticle"},"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. Ensure that no authentication is needed 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"},"RestowAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"RestowAttributeItem","description":"RestowAttributeItem"},"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"},"RestowItemStatus":{"description":"Status of the restow item","enum":["CANCELED","CLOSED","OPEN"],"type":"string","title":"RestowItemStatus"}}}}
```

## The RestowItemActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/RestowItemRestowActionParameter"},{"$ref":"#/components/schemas/RestowItemCancelActionParameter"}],"title":"RestowItemActionsParameter","description":"RestowItemActionsParameter"},"RestowItemRestowActionParameter":{"additionalProperties":false,"description":"Action to restow a RestowItem.","properties":{"location":{"$ref":"#/components/schemas/Location"},"name":{"$ref":"#/components/schemas/RestowItemRestowActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"RestowItemRestowActionParameter"},"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"},"RestowItemRestowActionEnum":{"enum":["RESTOW"],"type":"string","title":"RestowItemRestowActionEnum","description":"RestowItemRestowActionEnum"},"RestowItemCancelActionParameter":{"additionalProperties":false,"description":"Action to cancel a RestowItem.","properties":{"name":{"$ref":"#/components/schemas/RestowItemCancelActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"RestowItemCancelActionParameter"},"RestowItemCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"RestowItemCancelActionEnum","description":"RestowItemCancelActionEnum"}}}}
```

## The RestowItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/RestowAttributeItem"},"type":"array"}},"type":"object"}],"xml":{"name":"RestowItemArticle"},"title":"RestowItemArticle","description":"RestowItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"RestowAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"RestowAttributeItem","description":"RestowAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The RestowItemCancelActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"RestowItemCancelActionEnum","description":"RestowItemCancelActionEnum"}}}}
```

## The RestowItemCancelActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemCancelActionParameter":{"additionalProperties":false,"description":"Action to cancel a RestowItem.","properties":{"name":{"$ref":"#/components/schemas/RestowItemCancelActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"RestowItemCancelActionParameter"},"RestowItemCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"RestowItemCancelActionEnum","description":"RestowItemCancelActionEnum"}}}}
```

## The RestowItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemForCreation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/RestowItemArticle"},"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"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"location":{"$ref":"#/components/schemas/Location"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"default":1,"format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"restowed":{"default":false,"description":"Indicates if the restowItem has been restowed","type":"boolean"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["facilityRef","article","quantity"],"type":"object","title":"RestowItemForCreation","description":"RestowItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"RestowItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/RestowAttributeItem"},"type":"array"}},"type":"object"}],"xml":{"name":"RestowItemArticle"},"title":"RestowItemArticle","description":"RestowItemArticle"},"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. Ensure that no authentication is needed 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"},"RestowAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"RestowAttributeItem","description":"RestowAttributeItem"},"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"}}}}
```

## The RestowItemPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemPatchActions":{"description":"Deprecated Actions to modify restow items - please use /api/restowitem/{id}/actions","properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyRestowItemAction"}]},"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"],"title":"RestowItemPatchActions","type":"object","xml":{"name":"RestowItemPatchActions"}},"ModifyRestowItemAction":{"additionalProperties":false,"description":"Action to modify a restow item.","properties":{"action":{"description":"Use value 'ModifyRestowItem', because you want to modify a restow item","enum":["ModifyRestowItem"],"type":"string"},"location":{"$ref":"#/components/schemas/Location"},"restowed":{"default":false,"description":"Indicates if the restowItem has been restowed","type":"boolean"}},"required":["action","restowed"],"title":"ModifyRestowItemAction","type":"object"},"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"}}}}
```

## The RestowItemRestowActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemRestowActionEnum":{"enum":["RESTOW"],"type":"string","title":"RestowItemRestowActionEnum","description":"RestowItemRestowActionEnum"}}}}
```

## The RestowItemRestowActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemRestowActionParameter":{"additionalProperties":false,"description":"Action to restow a RestowItem.","properties":{"location":{"$ref":"#/components/schemas/Location"},"name":{"$ref":"#/components/schemas/RestowItemRestowActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"RestowItemRestowActionParameter"},"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"},"RestowItemRestowActionEnum":{"enum":["RESTOW"],"type":"string","title":"RestowItemRestowActionEnum","description":"RestowItemRestowActionEnum"}}}}
```

## The RestowItemsSortOptionsEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemsSortOptionsEnum":{"enum":["CREATED_DESC","CREATED_ASC","LAST_MODIFIED_DESC","LAST_MODIFIED_ASC"],"type":"string","title":"RestowItemsSortOptionsEnum","description":"RestowItemsSortOptionsEnum"}}}}
```

## The RestowItemStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RestowItemStatus":{"description":"Status of the restow item","enum":["CANCELED","CLOSED","OPEN"],"type":"string","title":"RestowItemStatus"}}}}
```

## The ReturnConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnConfiguration":{"properties":{"active":{"default":true,"deprecated":true,"description":"Enable or disable legacy returns. Use returnTypeConfiguration instead","type":"boolean"},"allowTriggerRefund":{"default":false,"description":"If true, a refund can be triggered. If false, the endpoints to trigger a refund are disabled.","type":"boolean"},"availableDecisionReasons":{"items":{"$ref":"#/components/schemas/AvailableDecisionReasons"},"maxItems":100,"type":"array"},"availableItemConditions":{"items":{"$ref":"#/components/schemas/AvailableItemCondition"},"type":"array"},"availableReturnReasons":{"items":{"$ref":"#/components/schemas/AvailableReturnReason"},"type":"array"},"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"},"returnTypeConfiguration":{"$ref":"#/components/schemas/ReturnTypeConfiguration"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["active","version"],"title":"ReturnConfiguration","type":"object","description":"ReturnConfiguration"},"AvailableDecisionReasons":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"context":{"description":"Context in which this reason is available","items":{"$ref":"#/components/schemas/DecisionReasonContext"},"maxItems":10,"minItems":1,"type":"array"},"reason":{"description":"Translated value from  reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"AvailableDecisionReasons","type":"object","description":"AvailableDecisionReasons"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"DecisionReasonContext":{"properties":{"type":{"enum":["ITEM_RETURN_LINE_ITEM_STATUS"],"type":"string"},"values":{"items":{"enum":["ACCEPTED","REJECTED","WAITING_FOR_INPUT"],"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"title":"DecisionReasonContext","type":"object","description":"DecisionReasonContext"},"AvailableItemCondition":{"properties":{"conditionLocalized":{"$ref":"#/components/schemas/LocaleString"}},"required":["conditionLocalized"],"title":"AvailableItemCondition","type":"object","description":"AvailableItemCondition"},"AvailableReturnReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"identifier":{"description":"Small identifier to be displayed and printed. Allowed values are 1-99 and A-Z. Needs to be unique respecting all other reasons. If not set, an ascending will be chosen automatically","type":"string"}},"required":["reasonLocalized"],"title":"AvailableReturnReason","type":"object","description":"AvailableReturnReason"},"ReturnTypeConfiguration":{"properties":{"type":{"enum":["RETURN","ITEM_RETURN"],"type":"string"}},"required":["type"],"title":"ReturnTypeConfiguration","type":"object","description":"ReturnTypeConfiguration"}}}}
```

## The ReturnedLineItemRefund object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnedLineItemRefund":{"properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","maximum":100,"minimum":0,"type":"number"},"price":{"allOf":[{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"}],"description":"Either price or percent must be set, not both."},"status":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string"}},"required":["status"],"title":"ReturnedLineItemRefund","type":"object","description":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The ReturnedLineItemRefundPrice object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The ReturnManagementPayloadBase object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ReturnManagementReturnPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnManagementReturnPayload":{"allOf":[{"$ref":"#/components/schemas/ReturnManagementPayloadBase"}],"properties":{"itemReturn":{"properties":{"id":{"type":"string"},"returnedLineItems":{"items":{"type":"object"},"type":"array"},"status":{"type":"string"}},"type":"object"}},"type":"object","title":"ReturnManagementReturnPayload","description":"ReturnManagementReturnPayload"},"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ReturnNote object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnNote":{"properties":{"companyAddress":{"$ref":"#/components/schemas/CompanyAddress"},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress"},"deliveryAddresses":{"description":"if this field is filled, the delivery address will be taken from here according to this sorting: INVOICE_ADDRESS > POSTAL_ADDRESS. Each type is only allowed once.","items":{"$ref":"#/components/schemas/DeliveryAddressWithType"},"type":"array"},"items":{"items":{"$ref":"#/components/schemas/ReturnNoteItem"},"type":"array"},"orderInformation":{"$ref":"#/components/schemas/OrderInformation"},"qrCodeContent":{"type":"string"}},"required":["orderInformation","items"],"type":"object","title":"ReturnNote","description":"ReturnNote"},"CompanyAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"country":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"name":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["name","street","postalCode","city","country"],"type":"object","title":"CompanyAddress","description":"CompanyAddress"},"DeliveryAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"companyName":{"pattern":"^.+$","type":"string"},"firstName":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"lastName":{"pattern":"^.+$","type":"string"},"personalTitle":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","postalCode","city"],"type":"object","title":"DeliveryAddress","description":"DeliveryAddress"},"DeliveryAddressWithType":{"allOf":[{"$ref":"#/components/schemas/DeliveryAddress"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"}},"required":["street","houseNumber","postalCode","city","addressType"],"type":"object","title":"DeliveryAddressWithType","description":"DeliveryAddressWithType"},"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"},"ReturnNoteItem":{"properties":{"id":{"type":"string"},"quantity":{"description":"optional parameter for picked quantity of the given line item","type":"integer"},"substitutes":{"description":"Titel of the item which is substituted through this item","type":"string"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ReturnNoteItem","description":"ReturnNoteItem"},"OrderInformation":{"properties":{"orderDate":{"description":"The date the order was created.","format":"date-time","type":"string"},"orderNumber":{"description":"An identifier for the order.","pattern":"^.+$","type":"string"}},"type":"object","title":"OrderInformation","description":"OrderInformation"}}}}
```

## The ReturnNoteConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnNoteConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"description":"Return Note Configuration","properties":{"articleIdLabel":{"$ref":"#/components/schemas/LocaleString"},"articleTitleLabel":{"$ref":"#/components/schemas/LocaleString"},"companyAddress":{"$ref":"#/components/schemas/CompanyAddress"},"disclaimer":{"$ref":"#/components/schemas/LocaleString"},"disclaimerHeadline":{"$ref":"#/components/schemas/LocaleString"},"displayPageLabel":{"default":false,"description":"Determines if the page label should be shown","type":"boolean"},"headline":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"logoUrl":{"type":"string"},"orderDateLabel":{"$ref":"#/components/schemas/LocaleString"},"orderNumberLabel":{"$ref":"#/components/schemas/LocaleString"},"pageLabel":{"$ref":"#/components/schemas/LocaleString"},"pdfBackgroundConfiguration":{"$ref":"#/components/schemas/PdfBackgroundConfiguration"},"quantityLabel":{"$ref":"#/components/schemas/LocaleString"},"reasons":{"deprecated":true,"description":"Deprecated - use ReturnConfiguration.availableReturnReasons instead","items":{"$ref":"#/components/schemas/LocaleString"},"type":"array"},"returnReasonExplanation":{"$ref":"#/components/schemas/LocaleString"},"returnReasonExplanationHeadline":{"$ref":"#/components/schemas/LocaleString"},"returnReasonLabel":{"$ref":"#/components/schemas/LocaleString"},"substituteText":{"$ref":"#/components/schemas/LocaleString"}},"required":["id","orderDateLabel","orderNumberLabel","headline","quantityLabel","articleIdLabel","articleTitleLabel","returnReasonLabel","disclaimerHeadline","disclaimer","pageLabel"],"title":"ReturnNoteConfiguration","type":"object"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"CompanyAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"country":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"name":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["name","street","postalCode","city","country"],"type":"object","title":"CompanyAddress","description":"CompanyAddress"},"PdfBackgroundConfiguration":{"properties":{"firstPageBackgroundFileUrl":{"description":"File url of the background image that will be used for the first page","type":"string"},"followingPageBackgroundFileUrl":{"description":"File url of background image that will be used for 2-n pages","type":"string"}},"type":"object","title":"PdfBackgroundConfiguration","description":"PdfBackgroundConfiguration"}}}}
```

## The ReturnNoteConfigurationForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnNoteConfigurationForUpsert":{"additionalProperties":false,"properties":{"articleIdLabel":{"$ref":"#/components/schemas/LocaleString"},"articleTitleLabel":{"$ref":"#/components/schemas/LocaleString"},"companyAddress":{"$ref":"#/components/schemas/CompanyAddress"},"disclaimer":{"$ref":"#/components/schemas/LocaleString"},"disclaimerHeadline":{"$ref":"#/components/schemas/LocaleString"},"displayPageLabel":{"default":false,"description":"Determines if the page label should be shown","type":"boolean"},"headline":{"$ref":"#/components/schemas/LocaleString"},"logo":{"$ref":"#/components/schemas/NamedFile"},"orderDateLabel":{"$ref":"#/components/schemas/LocaleString"},"orderNumberLabel":{"$ref":"#/components/schemas/LocaleString"},"pageLabel":{"$ref":"#/components/schemas/LocaleString"},"pdfBackgroundConfiguration":{"$ref":"#/components/schemas/PdfBackgroundConfigurationForUpsert"},"quantityLabel":{"$ref":"#/components/schemas/LocaleString"},"reasons":{"deprecated":true,"description":"Deprecated - use ReturnConfiguration.availableReturnReasons instead","items":{"$ref":"#/components/schemas/LocaleString"},"type":"array"},"returnReasonExplanation":{"$ref":"#/components/schemas/LocaleString"},"returnReasonExplanationHeadline":{"$ref":"#/components/schemas/LocaleString"},"returnReasonLabel":{"$ref":"#/components/schemas/LocaleString"},"substituteText":{"$ref":"#/components/schemas/LocaleString"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["orderDateLabel","orderNumberLabel","headline","quantityLabel","articleIdLabel","articleTitleLabel","returnReasonLabel","disclaimerHeadline","disclaimer","pageLabel","version"],"type":"object","title":"ReturnNoteConfigurationForUpsert","description":"ReturnNoteConfigurationForUpsert"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"CompanyAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"country":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"name":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["name","street","postalCode","city","country"],"type":"object","title":"CompanyAddress","description":"CompanyAddress"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"PdfBackgroundConfigurationForUpsert":{"properties":{"firstPageBackgroundFile":{"$ref":"#/components/schemas/NamedFile"},"followingPageBackgroundFile":{"$ref":"#/components/schemas/NamedFile"}},"type":"object","title":"PdfBackgroundConfigurationForUpsert","description":"PdfBackgroundConfigurationForUpsert"}}}}
```

## The ReturnNoteItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnNoteItem":{"properties":{"id":{"type":"string"},"quantity":{"description":"optional parameter for picked quantity of the given line item","type":"integer"},"substitutes":{"description":"Titel of the item which is substituted through this item","type":"string"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ReturnNoteItem","description":"ReturnNoteItem"}}}}
```

## The ReturnTypeConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ReturnTypeConfiguration":{"properties":{"type":{"enum":["RETURN","ITEM_RETURN"],"type":"string"}},"required":["type"],"title":"ReturnTypeConfiguration","type":"object","description":"ReturnTypeConfiguration"}}}}
```

## The Role object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Role":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contextLimitations":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contexts":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"created":{"description":"The date when the role was created.","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the role, which can be used to store additional information.","type":"object"},"description":{"description":"The description of the role, which provides more details about its purpose.","maxLength":100,"type":"string"},"displayName":{"description":"The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).","maxLength":50,"type":"string"},"lastModified":{"description":"The date when the role was last modified.","format":"date-time","type":"string"},"name":{"description":"The name of the role, which must be unique and is used to identify the role.","maxLength":20,"minLength":3,"type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"maxItems":500,"type":"array"},"version":{"description":"The version of the role.","type":"number"}},"required":["name","permissions","version","created","lastModified"],"title":"Role","type":"object","description":"Role"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The RoleForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoleForCreation":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contextLimitations":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contexts":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"customAttributes":{"description":"The custom attributes of the role, which can be used to store additional information.","type":"object"},"description":{"description":"The description of the role, which provides more details about its purpose.","maxLength":100,"type":"string"},"displayName":{"description":"The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).","maxLength":50,"type":"string"},"name":{"description":"The name of the role, which must be unique and is used to identify the role.","maxLength":20,"minLength":3,"type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"maxItems":500,"type":"array"}},"required":["name","permissions"],"title":"RoleForCreation","type":"object","description":"RoleForCreation"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The RoleForPatch object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoleForPatch":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contextLimitations":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contexts":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"customAttributes":{"description":"The custom attributes of the role, which can be used to store additional information.","type":"object"},"description":{"description":"The description of the role, which provides more details about its purpose.","maxLength":100,"type":"string"},"displayName":{"description":"The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).","maxLength":100,"type":"string"},"name":{"description":"The name of the role, which must be unique and is used to identify the role.","type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"maxItems":500,"type":"array"},"version":{"description":"The version of the role.","type":"number"}},"required":["version","name"],"title":"RoleForPatch","type":"object","description":"RoleForPatch"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The RoleForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoleForUpdate":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contextLimitations":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contexts":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"customAttributes":{"description":"The custom attributes of the role, which can be used to store additional information.","type":"object"},"description":{"description":"The description of the role, which provides more details about its purpose.","maxLength":100,"type":"string"},"displayName":{"description":"The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).","maxLength":50,"type":"string"},"name":{"description":"The name of the role, which must be unique and is used to identify the role.","maxLength":20,"minLength":3,"type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"maxItems":500,"type":"array"},"version":{"description":"The version of the role.","type":"number"}},"required":["name","permissions","version"],"title":"RoleForUpdate","type":"object","description":"RoleForUpdate"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The RolePaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RolePaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array"},"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","roles"],"title":"RolePaginatedResult","type":"object","description":"RolePaginatedResult"},"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"},"Role":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contextLimitations":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contexts":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"created":{"description":"The date when the role was created.","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the role, which can be used to store additional information.","type":"object"},"description":{"description":"The description of the role, which provides more details about its purpose.","maxLength":100,"type":"string"},"displayName":{"description":"The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).","maxLength":50,"type":"string"},"lastModified":{"description":"The date when the role was last modified.","format":"date-time","type":"string"},"name":{"description":"The name of the role, which must be unique and is used to identify the role.","maxLength":20,"minLength":3,"type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"maxItems":500,"type":"array"},"version":{"description":"The version of the role.","type":"number"}},"required":["name","permissions","version","created","lastModified"],"title":"Role","type":"object","description":"Role"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The RoleSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoleSearchPayload":{"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/RoleSearchQuery"},"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/RoleSort"},"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":"RoleSearchPayload","type":"object","description":"RoleSearchPayload"},"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"},"RoleSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/RoleSearchQuery"},"maxItems":500,"type":"array"},"description":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by description"},"displayName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by displayName"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/RoleSearchQuery"},"maxItems":500,"type":"array"}},"title":"RoleSearchQuery","type":"object","description":"RoleSearchQuery"},"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"},"RoleSort":{"properties":{"displayName":{"enum":["ASC","DESC"],"type":"string"}},"title":"RoleSort","type":"object","description":"RoleSort"}}}}
```

## The RoleSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoleSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/RoleSearchQuery"},"maxItems":500,"type":"array"},"description":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by description"},"displayName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by displayName"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/RoleSearchQuery"},"maxItems":500,"type":"array"}},"title":"RoleSearchQuery","type":"object","description":"RoleSearchQuery"},"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"}}}}
```

## The RoleSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoleSort":{"properties":{"displayName":{"enum":["ASC","DESC"],"type":"string"}},"title":"RoleSort","type":"object","description":"RoleSort"}}}}
```

## The RoutingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingConfiguration":{"additionalProperties":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This is the configuration for the distributing order management system. By changing the configuration you are able to change the behavior of the routing of orders henceforth.","properties":{"created":{"description":"The date this order was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"globalRoutingConfiguration":{"$ref":"#/components/schemas/GlobalRoutingConfiguration"},"id":{"type":"string"},"lastModified":{"description":"The date this order was modified last. This value is generated by the service.","format":"date-time","type":"string"},"prioritizationRules":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Contains the routing configuration for prioritization & routing for the whole tenant","items":{"$ref":"#/components/schemas/PrioritizationRule"},"type":"array"},"routingRule":{"$ref":"#/components/schemas/RoutingRule"},"timingMode":{"$ref":"#/components/schemas/RoutingConfigurationTiming"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","prioritizationRules","routingRule","globalRoutingConfiguration"],"type":"object","title":"RoutingConfiguration"},"GlobalRoutingConfiguration":{"description":"Global configuration for routing","properties":{"defaultPrice":{"default":10,"description":"Default price which is used if no price exists in order or listings","type":"number"},"fallbackFacilityConfiguration":{"$ref":"#/components/schemas/FallbackFacilityConfiguration"},"manualReroute":{"$ref":"#/components/schemas/GlobalManualRerouteConfiguration"},"routingTimeout":{"default":8,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Default amount of hours after which a routing plan is marked not routable. This field is deprecated in favour of stopRoutingAttemptsAfterTime","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"Default amount of time in ISO 8601 duration format after which a routing plan is marked not routable. The duration need to be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["defaultPrice"],"type":"object","title":"GlobalRoutingConfiguration"},"FallbackFacilityConfiguration":{"deprecated":true,"description":"@deprecated use RoutingStrategyFallbackFacilityConfiguration instead","properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"FallbackFacilityConfiguration"},"GlobalManualRerouteConfiguration":{"description":"Allows reroutes to be triggered manually via api.","properties":{"active":{"type":"boolean"}},"required":["active"],"type":"object","title":"GlobalManualRerouteConfiguration"},"PrioritizationRule":{"description":"You can select a default Prioritization Rule from the catalog. When you decide to select 'CUSTOM' you must also provide a vmExpression to match the type CustomPrioritizationRule.","properties":{"active":{"type":"boolean"},"id":{"description":"This value identifies this very instance of the prioritization rule. It is set autmatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/PrioritizationRuleImplementation"},"name":{"type":"string"}},"required":["active","name","implementation"],"type":"object","title":"PrioritizationRule"},"PrioritizationRuleImplementation":{"enum":["CUSTOM"],"type":"string","xml":{"name":"PrioritizationRuleImplementation"},"title":"PrioritizationRuleImplementation","description":"PrioritizationRuleImplementation"},"RoutingRule":{"additionalProperties":false,"properties":{"fences":{"items":{"$ref":"#/components/schemas/Fence"},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/OrderSplit"},"ratings":{"items":{"$ref":"#/components/schemas/Rating"},"type":"array"}},"required":["ratings","fences"],"type":"object","title":"RoutingRule","description":"RoutingRule"},"Fence":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"id":{"description":"This value identifies this very instance of the fence. It is set autmatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"}},"required":["active","implementation","id"],"type":"object","title":"Fence","description":"Fence"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"OrderSplit":{"additionalProperties":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","properties":{"active":{"default":false,"type":"boolean"},"activeForSameDay":{"default":false,"type":"boolean"},"fixedCountConfiguration":{"$ref":"#/components/schemas/FixedCountConfiguration"},"orderSplitType":{"$ref":"#/components/schemas/OrderSplitType"},"shouldUseWaitingRoomForPreBackOrderItems":{"default":false,"type":"boolean"}},"required":["active","orderSplitType"],"type":"object","title":"OrderSplit"},"FixedCountConfiguration":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration of fixed count split.","properties":{"maxSplitCount":{"description":"This setting defines how often an order split might be performed to fulfill the order.","minimum":1,"type":"number"}},"required":["maxSplitCount"],"type":"object","title":"FixedCountConfiguration"},"OrderSplitType":{"description":"The type of order split","enum":["FIXED_COUNT"],"type":"string","xml":{"name":"OrderSplitType"},"title":"OrderSplitType"},"Rating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"id":{"description":"This value identifies this very instance of the rating. It is set automatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"}},"required":["name","active","implementation","maxPenalty","id"],"type":"object","title":"Rating"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingConfigurationTiming":{"description":"Configuration for the timing of routing decisions","properties":{"options":{"type":"object"},"type":{"$ref":"#/components/schemas/RoutingConfigurationTimingType"}},"required":["type"],"type":"object","title":"RoutingConfigurationTiming"},"RoutingConfigurationTimingType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The available types for routing timing.","enum":["DIRECT","MANUAL"],"type":"string","xml":{"name":"RoutingConfigurationTimingType"},"title":"RoutingConfigurationTimingType"}}}}
```

## The RoutingConfigurationsPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingConfigurationsPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyFenceAction"},{"$ref":"#/components/schemas/ModifyRatingAction"},{"$ref":"#/components/schemas/ModifyTimingModeAction"},{"$ref":"#/components/schemas/ModifyOrderSplitAction"},{"$ref":"#/components/schemas/ModifyPrioritizationAction"},{"$ref":"#/components/schemas/ModifyGlobalRoutingConfigurationAction"}]},"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":"RoutingConfigurationsPatchActions"},"title":"RoutingConfigurationsPatchActions","description":"RoutingConfigurationsPatchActions"},"ModifyFenceAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyFence', because you want to modify a fence.","enum":["ModifyFence"],"type":"string"},"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"id":{"type":"string"}},"required":["action","id"],"type":"object"}],"description":"Action to Modify a Fence.","title":"ModifyFenceAction","xml":{"name":"ModifyFenceAction"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"ModifyRatingAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyRating', because you want to modify a rating.","enum":["ModifyRating"],"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"}},"required":["action","id"],"type":"object"}],"description":"Action to Modify a Rating.","title":"ModifyRatingAction","xml":{"name":"ModifyRatingAction"}},"ModifyTimingModeAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyTimingMode', because you want to modify a timing mode.","enum":["ModifyTimingMode"],"type":"string"},"timingMode":{"$ref":"#/components/schemas/RoutingConfigurationTiming"}},"required":["action"],"type":"object"}],"description":"Action to Modify the Timing Mode.","title":"ModifyTimingModeAction","xml":{"name":"ModifyTimingModeAction"}},"RoutingConfigurationTiming":{"description":"Configuration for the timing of routing decisions","properties":{"options":{"type":"object"},"type":{"$ref":"#/components/schemas/RoutingConfigurationTimingType"}},"required":["type"],"type":"object","title":"RoutingConfigurationTiming"},"RoutingConfigurationTimingType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The available types for routing timing.","enum":["DIRECT","MANUAL"],"type":"string","xml":{"name":"RoutingConfigurationTimingType"},"title":"RoutingConfigurationTimingType"},"ModifyOrderSplitAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyOrderSplit', because you want to modify the configuration for the an order split.","enum":["ModifyOrderSplit"],"type":"string"},"active":{"default":false,"type":"boolean"},"activeForSameDay":{"default":false,"type":"boolean"},"fixedCountConfiguration":{"$ref":"#/components/schemas/FixedCountConfiguration"},"orderSplitType":{"$ref":"#/components/schemas/OrderSplitType"},"shouldUseWaitingRoomForPreBackOrderItems":{"default":false,"type":"boolean"}},"required":["action"],"type":"object"}],"description":"Action to Modify the Order Split Configuration.","title":"ModifyOrderSplitAction","xml":{"name":"ModifyOrderSplitAction"}},"FixedCountConfiguration":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration of fixed count split.","properties":{"maxSplitCount":{"description":"This setting defines how often an order split might be performed to fulfill the order.","minimum":1,"type":"number"}},"required":["maxSplitCount"],"type":"object","title":"FixedCountConfiguration"},"OrderSplitType":{"description":"The type of order split","enum":["FIXED_COUNT"],"type":"string","xml":{"name":"OrderSplitType"},"title":"OrderSplitType"},"ModifyPrioritizationAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyPrioritization', because you want to modify prioritization.","enum":["ModifyPrioritization"],"type":"string"},"active":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["action","id"],"type":"object"}],"description":"Action to Modify the Prioritization Configuration.","title":"ModifyPrioritizationAction","xml":{"name":"ModifyPrioritizationAction"}},"ModifyGlobalRoutingConfigurationAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyGlobalRoutingConfiguration', because you want to modify global routing configuration.","enum":["ModifyGlobalRoutingConfiguration"],"type":"string"},"defaultPrice":{"default":10,"description":"Default price which is used if no price exists in order or listings","type":"number"},"fallbackFacilityConfiguration":{"$ref":"#/components/schemas/FallbackFacilityConfigurationForPatch"},"manualRerouteConfiguration":{"$ref":"#/components/schemas/GlobalManualRerouteConfiguration"},"routingTimeout":{"default":8,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Default amount of hours after which a routing plan is marked not routable. This field is deprecated in favour of stopRoutingAttemptsAfterTime","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"Default amount of time in ISO 8601 duration format after which a routing plan is marked not routable. The duration need to be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"@deprecated use RoutingStrategy configuration actions instead 'Action to Modify the Global Routing Configuration.'","title":"ModifyGlobalRoutingConfigurationAction"},"FallbackFacilityConfigurationForPatch":{"deprecated":true,"description":"@deprecated use RoutingStrategyFallbackFacilityConfiguration instead","properties":{"active":{"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"title":"FallbackFacilityConfigurationForPatch"},"GlobalManualRerouteConfiguration":{"description":"Allows reroutes to be triggered manually via api.","properties":{"active":{"type":"boolean"}},"required":["active"],"type":"object","title":"GlobalManualRerouteConfiguration"}}}}
```

## The RoutingConfigurationTiming object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingConfigurationTiming":{"description":"Configuration for the timing of routing decisions","properties":{"options":{"type":"object"},"type":{"$ref":"#/components/schemas/RoutingConfigurationTimingType"}},"required":["type"],"type":"object","title":"RoutingConfigurationTiming"},"RoutingConfigurationTimingType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The available types for routing timing.","enum":["DIRECT","MANUAL"],"type":"string","xml":{"name":"RoutingConfigurationTimingType"},"title":"RoutingConfigurationTimingType"}}}}
```

## The RoutingConfigurationTimingType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingConfigurationTimingType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The available types for routing timing.","enum":["DIRECT","MANUAL"],"type":"string","xml":{"name":"RoutingConfigurationTimingType"},"title":"RoutingConfigurationTimingType"}}}}
```

## The RoutingDecisionContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingDecisionContext":{"enum":["LISTING","CARRIER"],"title":"RoutingDecisionContext","description":"RoutingDecisionContext"}}}}
```

## The RoutingDecisionLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingDecisionLog":{"properties":{"created":{"description":"The date this order was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"executionResults":{"$ref":"#/components/schemas/SourcingOptionsExecutionResults"},"id":{"type":"string"},"lastModified":{"description":"The date this order was modified last. This value is generated by the service.","format":"date-time","type":"string"},"relatedRefs":{"$ref":"#/components/schemas/RoutingDecisionLogRelatedRefs"},"routingStrategyEvaluationResult":{"$ref":"#/components/schemas/RoutingStrategyEvaluationResult"},"sourcingOptions":{"items":{"$ref":"#/components/schemas/SourcingOption"},"type":"array"}},"required":["id","created","lastModified","relatedRefs","sourcingOptions","executionResults"],"type":"object","xml":{"name":"RoutingDecisionLog"},"title":"RoutingDecisionLog","description":"RoutingDecisionLog"},"SourcingOptionsExecutionResults":{"properties":{"totalRatingResults":{"items":{"$ref":"#/components/schemas/SourcingOptionTotalRatingResult"},"type":"array"}},"type":"object","title":"SourcingOptionsExecutionResults","description":"SourcingOptionsExecutionResults"},"SourcingOptionTotalRatingResult":{"properties":{"avgPenalty":{"type":"number"},"id":{"type":"string"},"maxPenalty":{"type":"number"},"minPenalty":{"type":"number"}},"required":["id","minPenalty","maxPenalty","avgPenalty"],"type":"object","title":"SourcingOptionTotalRatingResult","description":"SourcingOptionTotalRatingResult"},"RoutingDecisionLogRelatedRefs":{"properties":{"orderRef":{"description":"The orderRef of the order this decision log is related to.","type":"string"},"processRef":{"description":"The processRef of the process this decision log is related to.","type":"string"},"routingPlanRefs":{"description":"The routingPlanRefs of the routing plans this decision log is related to.","items":{"type":"string"},"type":"array"},"runId":{"description":"The runId of the connected sourcingOption this decision log is related to.","type":"string"},"sourcingOptionRefs":{"description":"The sourcingOptionsRefs of the request this decision log is related to.","items":{"type":"string"},"type":"array"},"sourcingOptionsRef":{"deprecated":true,"description":"The sourcingOptionsRef of the request this decision log is related to.","type":"string"},"tenantOrderId":{"description":"The tenantOrderId of the order this decision log is related to.","type":"string"}},"type":"object","xml":{"name":"RoutingDecisionLogRelatedRefs"},"title":"RoutingDecisionLogRelatedRefs","description":"RoutingDecisionLogRelatedRefs"},"RoutingStrategyEvaluationResult":{"properties":{"evaluatedConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"evaluatedPath":{"items":{"$ref":"#/components/schemas/RoutingStrategyPathElement"},"type":"array"}},"required":["evaluatedConfig","evaluatedPath"],"type":"object","title":"RoutingStrategyEvaluationResult","description":"RoutingStrategyEvaluationResult"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyPathElement":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"evaluationResult":{"$ref":"#/components/schemas/RoutingStrategyEvaluationResultType"},"ref":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyPathElementType"}},"required":["type","ref","evaluationResult","nameLocalized"],"type":"object","title":"RoutingStrategyPathElement","description":"RoutingStrategyPathElement"},"RoutingStrategyEvaluationResultType":{"enum":["NODE_INACTIVE","NODE_ACTIVE","CONDITION_INACTIVE","CONDITION_FALSE","CONDITION_TRUE"],"type":"string","title":"RoutingStrategyEvaluationResultType","description":"RoutingStrategyEvaluationResultType"},"RoutingStrategyPathElementType":{"enum":["CONDITION","NODE"],"type":"string","title":"RoutingStrategyPathElementType","description":"RoutingStrategyPathElementType"},"SourcingOption":{"properties":{"estimatedDeliveryDate":{"description":"Estimated delivery date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"estimatedPickupDate":{"description":"Estimated pickup date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"id":{"type":"string"},"listingDetails":{"items":{"$ref":"#/components/schemas/SourcingOptionListingDetails"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/SourcingOptionNode"},"type":"array"},"nonAssignedOrderLineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"priorityRatingResults":{"items":{"$ref":"#/components/schemas/PriorityRatingResult"},"type":"array"},"ratingResults":{"items":{"$ref":"#/components/schemas/RatingResult"},"type":"array"},"runId":{"type":"string"},"totalCosts":{"$ref":"#/components/schemas/SourcingOptionCosts"},"totalPenalty":{"description":"The total calculated penalty we calculated for this option","type":"number"},"transfers":{"items":{"$ref":"#/components/schemas/SourcingOptionTransfer"},"type":"array"},"validUntil":{"description":"The latest date at which this option is still valid, as an ISO8601 UTC timestamp string.","type":"string"}},"required":["id","runId","totalPenalty","nodes","transfers","ratingResults","priorityRatingResults"],"type":"object","title":"SourcingOption","description":"SourcingOption"},"SourcingOptionListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"type":"object"},"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"}},"title":"SourcingOptionListingDetails","description":"SourcingOptionListingDetails"},"SourcingOptionNode":{"properties":{"facilityRef":{"type":"string"},"id":{"description":"id of this node, unique for this Sourcing Option Responses","type":"string"},"isPickUpLocation":{"description":"Indicates if this node is a pick up location","type":"boolean"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"tenantFacilityId":{"type":"string"},"type":{"$ref":"#/components/schemas/NodeType"}},"required":["id","type","lineItems"],"type":"object","title":"SourcingOptionNode","description":"SourcingOptionNode"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"},"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"},"PriorityRatingResult":{"properties":{"id":{"type":"string"},"matchesPriorityMinimum":{"type":"boolean"},"name":{"type":"string"},"routingStrategyNodeId":{"type":"string"},"type":{"$ref":"#/components/schemas/RatingResultType"}},"required":["id","type","routingStrategyNodeId","matchesPriorityMinimum"],"title":"PriorityRatingResult","description":"PriorityRatingResult"},"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"},"RatingResult":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"penalty":{"type":"number"},"routingStrategyNodeId":{"type":"string"},"type":{"description":"The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'","type":"string"}},"required":["penalty","id","type","routingStrategyNodeId","name"],"title":"RatingResult","description":"RatingResult"},"SourcingOptionCosts":{"additionalProperties":false,"properties":{"salesPrices":{"description":"Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.","items":{"$ref":"#/components/schemas/SourcingOptionSalesPrice"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money"},"totalSalesPriceAmount":{"$ref":"#/components/schemas/Money"},"totalShippingCosts":{"$ref":"#/components/schemas/ShippingCosts"}},"required":["salesPrices"],"type":"object","title":"SourcingOptionCosts","description":"SourcingOptionCosts"},"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"SourcingOptionTransfer":{"properties":{"carrier":{"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"}},"type":"object"},"costDetails":{"description":"The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"existenceReason":{"$ref":"#/components/schemas/SourcingOptionTransferExistenceReason"},"facilityConnectionRef":{"type":"string"},"fallbackCosts":{"$ref":"#/components/schemas/Money"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"packagingInformation":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingInformation"},"type":"array"},"sourceNodeRef":{"type":"string"},"strandId":{"type":"string"},"targetNodeRef":{"type":"string"},"timeLine":{"$ref":"#/components/schemas/TransferTimeLine"},"totalCosts":{"$ref":"#/components/schemas/Money"},"transferGroup":{"description":"The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.","type":"string"}},"required":["sourceNodeRef","targetNodeRef","lineItems","packagingInformation"],"type":"object","title":"SourcingOptionTransfer","description":"SourcingOptionTransfer"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"},"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"}}}}
```

## The RoutingDecisionLogRelatedRefs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingDecisionLogRelatedRefs":{"properties":{"orderRef":{"description":"The orderRef of the order this decision log is related to.","type":"string"},"processRef":{"description":"The processRef of the process this decision log is related to.","type":"string"},"routingPlanRefs":{"description":"The routingPlanRefs of the routing plans this decision log is related to.","items":{"type":"string"},"type":"array"},"runId":{"description":"The runId of the connected sourcingOption this decision log is related to.","type":"string"},"sourcingOptionRefs":{"description":"The sourcingOptionsRefs of the request this decision log is related to.","items":{"type":"string"},"type":"array"},"sourcingOptionsRef":{"deprecated":true,"description":"The sourcingOptionsRef of the request this decision log is related to.","type":"string"},"tenantOrderId":{"description":"The tenantOrderId of the order this decision log is related to.","type":"string"}},"type":"object","xml":{"name":"RoutingDecisionLogRelatedRefs"},"title":"RoutingDecisionLogRelatedRefs","description":"RoutingDecisionLogRelatedRefs"}}}}
```

## The RoutingDecisionLogs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingDecisionLogs":{"properties":{"decisionLogs":{"items":{"$ref":"#/components/schemas/RoutingDecisionLog"},"type":"array"},"total":{"description":"Total number of found decision logs for this query","type":"integer"}},"required":["decisionLogs","total"],"type":"object","title":"RoutingDecisionLogs","description":"RoutingDecisionLogs"},"RoutingDecisionLog":{"properties":{"created":{"description":"The date this order was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"executionResults":{"$ref":"#/components/schemas/SourcingOptionsExecutionResults"},"id":{"type":"string"},"lastModified":{"description":"The date this order was modified last. This value is generated by the service.","format":"date-time","type":"string"},"relatedRefs":{"$ref":"#/components/schemas/RoutingDecisionLogRelatedRefs"},"routingStrategyEvaluationResult":{"$ref":"#/components/schemas/RoutingStrategyEvaluationResult"},"sourcingOptions":{"items":{"$ref":"#/components/schemas/SourcingOption"},"type":"array"}},"required":["id","created","lastModified","relatedRefs","sourcingOptions","executionResults"],"type":"object","xml":{"name":"RoutingDecisionLog"},"title":"RoutingDecisionLog","description":"RoutingDecisionLog"},"SourcingOptionsExecutionResults":{"properties":{"totalRatingResults":{"items":{"$ref":"#/components/schemas/SourcingOptionTotalRatingResult"},"type":"array"}},"type":"object","title":"SourcingOptionsExecutionResults","description":"SourcingOptionsExecutionResults"},"SourcingOptionTotalRatingResult":{"properties":{"avgPenalty":{"type":"number"},"id":{"type":"string"},"maxPenalty":{"type":"number"},"minPenalty":{"type":"number"}},"required":["id","minPenalty","maxPenalty","avgPenalty"],"type":"object","title":"SourcingOptionTotalRatingResult","description":"SourcingOptionTotalRatingResult"},"RoutingDecisionLogRelatedRefs":{"properties":{"orderRef":{"description":"The orderRef of the order this decision log is related to.","type":"string"},"processRef":{"description":"The processRef of the process this decision log is related to.","type":"string"},"routingPlanRefs":{"description":"The routingPlanRefs of the routing plans this decision log is related to.","items":{"type":"string"},"type":"array"},"runId":{"description":"The runId of the connected sourcingOption this decision log is related to.","type":"string"},"sourcingOptionRefs":{"description":"The sourcingOptionsRefs of the request this decision log is related to.","items":{"type":"string"},"type":"array"},"sourcingOptionsRef":{"deprecated":true,"description":"The sourcingOptionsRef of the request this decision log is related to.","type":"string"},"tenantOrderId":{"description":"The tenantOrderId of the order this decision log is related to.","type":"string"}},"type":"object","xml":{"name":"RoutingDecisionLogRelatedRefs"},"title":"RoutingDecisionLogRelatedRefs","description":"RoutingDecisionLogRelatedRefs"},"RoutingStrategyEvaluationResult":{"properties":{"evaluatedConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"evaluatedPath":{"items":{"$ref":"#/components/schemas/RoutingStrategyPathElement"},"type":"array"}},"required":["evaluatedConfig","evaluatedPath"],"type":"object","title":"RoutingStrategyEvaluationResult","description":"RoutingStrategyEvaluationResult"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyPathElement":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"evaluationResult":{"$ref":"#/components/schemas/RoutingStrategyEvaluationResultType"},"ref":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyPathElementType"}},"required":["type","ref","evaluationResult","nameLocalized"],"type":"object","title":"RoutingStrategyPathElement","description":"RoutingStrategyPathElement"},"RoutingStrategyEvaluationResultType":{"enum":["NODE_INACTIVE","NODE_ACTIVE","CONDITION_INACTIVE","CONDITION_FALSE","CONDITION_TRUE"],"type":"string","title":"RoutingStrategyEvaluationResultType","description":"RoutingStrategyEvaluationResultType"},"RoutingStrategyPathElementType":{"enum":["CONDITION","NODE"],"type":"string","title":"RoutingStrategyPathElementType","description":"RoutingStrategyPathElementType"},"SourcingOption":{"properties":{"estimatedDeliveryDate":{"description":"Estimated delivery date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"estimatedPickupDate":{"description":"Estimated pickup date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"id":{"type":"string"},"listingDetails":{"items":{"$ref":"#/components/schemas/SourcingOptionListingDetails"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/SourcingOptionNode"},"type":"array"},"nonAssignedOrderLineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"priorityRatingResults":{"items":{"$ref":"#/components/schemas/PriorityRatingResult"},"type":"array"},"ratingResults":{"items":{"$ref":"#/components/schemas/RatingResult"},"type":"array"},"runId":{"type":"string"},"totalCosts":{"$ref":"#/components/schemas/SourcingOptionCosts"},"totalPenalty":{"description":"The total calculated penalty we calculated for this option","type":"number"},"transfers":{"items":{"$ref":"#/components/schemas/SourcingOptionTransfer"},"type":"array"},"validUntil":{"description":"The latest date at which this option is still valid, as an ISO8601 UTC timestamp string.","type":"string"}},"required":["id","runId","totalPenalty","nodes","transfers","ratingResults","priorityRatingResults"],"type":"object","title":"SourcingOption","description":"SourcingOption"},"SourcingOptionListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"type":"object"},"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"}},"title":"SourcingOptionListingDetails","description":"SourcingOptionListingDetails"},"SourcingOptionNode":{"properties":{"facilityRef":{"type":"string"},"id":{"description":"id of this node, unique for this Sourcing Option Responses","type":"string"},"isPickUpLocation":{"description":"Indicates if this node is a pick up location","type":"boolean"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"tenantFacilityId":{"type":"string"},"type":{"$ref":"#/components/schemas/NodeType"}},"required":["id","type","lineItems"],"type":"object","title":"SourcingOptionNode","description":"SourcingOptionNode"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"},"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"},"PriorityRatingResult":{"properties":{"id":{"type":"string"},"matchesPriorityMinimum":{"type":"boolean"},"name":{"type":"string"},"routingStrategyNodeId":{"type":"string"},"type":{"$ref":"#/components/schemas/RatingResultType"}},"required":["id","type","routingStrategyNodeId","matchesPriorityMinimum"],"title":"PriorityRatingResult","description":"PriorityRatingResult"},"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"},"RatingResult":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"penalty":{"type":"number"},"routingStrategyNodeId":{"type":"string"},"type":{"description":"The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'","type":"string"}},"required":["penalty","id","type","routingStrategyNodeId","name"],"title":"RatingResult","description":"RatingResult"},"SourcingOptionCosts":{"additionalProperties":false,"properties":{"salesPrices":{"description":"Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.","items":{"$ref":"#/components/schemas/SourcingOptionSalesPrice"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money"},"totalSalesPriceAmount":{"$ref":"#/components/schemas/Money"},"totalShippingCosts":{"$ref":"#/components/schemas/ShippingCosts"}},"required":["salesPrices"],"type":"object","title":"SourcingOptionCosts","description":"SourcingOptionCosts"},"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"SourcingOptionTransfer":{"properties":{"carrier":{"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"}},"type":"object"},"costDetails":{"description":"The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"existenceReason":{"$ref":"#/components/schemas/SourcingOptionTransferExistenceReason"},"facilityConnectionRef":{"type":"string"},"fallbackCosts":{"$ref":"#/components/schemas/Money"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"packagingInformation":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingInformation"},"type":"array"},"sourceNodeRef":{"type":"string"},"strandId":{"type":"string"},"targetNodeRef":{"type":"string"},"timeLine":{"$ref":"#/components/schemas/TransferTimeLine"},"totalCosts":{"$ref":"#/components/schemas/Money"},"transferGroup":{"description":"The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.","type":"string"}},"required":["sourceNodeRef","targetNodeRef","lineItems","packagingInformation"],"type":"object","title":"SourcingOptionTransfer","description":"SourcingOptionTransfer"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"},"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"}}}}
```

## The RoutingJournal object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingJournal":{"properties":{"blacklistedFacilityData":{"description":"List of blacklisted facilities associated with this routing journal entry","items":{"$ref":"#/components/schemas/RoutingJournalBlacklistedFacilityData"},"type":"array"},"changeType":{"description":"Type of change recorded in this routing journal entry","enum":["INITIAL","PROCESS_REROUTE","PROCESS_MANUAL_ASSIGNED","TASK_MANUAL_REROUTED","PICKJOB_REJECTED","PICKJOB_SHORTPICKED","PICKJOB_ABORTED","TIME_TRIGGERED_REROUTE"],"type":"string"},"created":{"description":"Creation date of this routing journal entry","format":"date-time","type":"string"},"id":{"description":"Unique identifier of this routing journal entry","type":"string"},"orderRef":{"description":"Reference to the associated order","type":"string"},"processRef":{"description":"Reference to the associated process","type":"string"},"routingPlanRefs":{"description":"References to the routing plans associated with this journal entry","items":{"type":"string"},"type":"array"},"runId":{"description":"The technical id for a sourcing option evaluation","type":"string"},"sourcingOptionRef":{"description":"Reference to the sourcing option used for routing","nullable":true,"type":"object"}},"required":["runId","blacklistedFacilityData","id","created","processRef","orderRef","sourcingOptionRef","changeType","routingPlanRefs"],"title":"RoutingJournal","type":"object","description":"RoutingJournal"},"RoutingJournalBlacklistedFacilityData":{"properties":{"facilityRef":{"description":"Reference to the facility","type":"string"}},"required":["facilityRef"],"title":"RoutingJournalBlacklistedFacilityData","type":"object","description":"RoutingJournalBlacklistedFacilityData"}}}}
```

## The RoutingJournalBlacklistedFacilityData object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingJournalBlacklistedFacilityData":{"properties":{"facilityRef":{"description":"Reference to the facility","type":"string"}},"required":["facilityRef"],"title":"RoutingJournalBlacklistedFacilityData","type":"object","description":"RoutingJournalBlacklistedFacilityData"}}}}
```

## The RoutingJournals object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingJournals":{"properties":{"routingJournals":{"description":"Array of the routing journal entries","items":{"$ref":"#/components/schemas/RoutingJournal"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"number"}},"required":["routingJournals","total"],"title":"RoutingJournals","type":"object","description":"RoutingJournals"},"RoutingJournal":{"properties":{"blacklistedFacilityData":{"description":"List of blacklisted facilities associated with this routing journal entry","items":{"$ref":"#/components/schemas/RoutingJournalBlacklistedFacilityData"},"type":"array"},"changeType":{"description":"Type of change recorded in this routing journal entry","enum":["INITIAL","PROCESS_REROUTE","PROCESS_MANUAL_ASSIGNED","TASK_MANUAL_REROUTED","PICKJOB_REJECTED","PICKJOB_SHORTPICKED","PICKJOB_ABORTED","TIME_TRIGGERED_REROUTE"],"type":"string"},"created":{"description":"Creation date of this routing journal entry","format":"date-time","type":"string"},"id":{"description":"Unique identifier of this routing journal entry","type":"string"},"orderRef":{"description":"Reference to the associated order","type":"string"},"processRef":{"description":"Reference to the associated process","type":"string"},"routingPlanRefs":{"description":"References to the routing plans associated with this journal entry","items":{"type":"string"},"type":"array"},"runId":{"description":"The technical id for a sourcing option evaluation","type":"string"},"sourcingOptionRef":{"description":"Reference to the sourcing option used for routing","nullable":true,"type":"object"}},"required":["runId","blacklistedFacilityData","id","created","processRef","orderRef","sourcingOptionRef","changeType","routingPlanRefs"],"title":"RoutingJournal","type":"object","description":"RoutingJournal"},"RoutingJournalBlacklistedFacilityData":{"properties":{"facilityRef":{"description":"Reference to the facility","type":"string"}},"required":["facilityRef"],"title":"RoutingJournalBlacklistedFacilityData","type":"object","description":"RoutingJournalBlacklistedFacilityData"}}}}
```

## The RoutingPlan object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlanCustomServicesArticleItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesArticleItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsListFilter"},"RoutingPlanCustomServicesArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter":{"properties":{"additionalInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by additionalInformationRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter":{"properties":{"additionalInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by additionalInformationRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesCustomServiceDefinitionFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesCustomServiceDefinitionFilter":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"}],"description":"Nested list search by additionalInformation"},"customServiceRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by customServiceRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter":{"properties":{"additionalInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by additionalInformationRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesCustomServiceItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesCustomServiceItemsFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"}],"description":"Nested list search by articleItems"}},"title":"RoutingPlanCustomServicesCustomServiceItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesCustomServiceItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesCustomServiceItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"}],"description":"Nested list search by articleItems"}},"title":"RoutingPlanCustomServicesCustomServiceItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"},"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"}}}}
```

## The RoutingPlanCustomServicesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsListFilter"}],"description":"Nested list search by articleItems"},"customServiceDefinition":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionFilter"}],"description":"Nested search by customServiceDefinition"},"customServiceItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsListFilter"}],"description":"Nested list search by customServiceItems"}},"title":"RoutingPlanCustomServicesFilter","type":"object","description":"RoutingPlanCustomServicesFilter"},"RoutingPlanCustomServicesArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsListFilter"},"RoutingPlanCustomServicesArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsFilter"},"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"},"RoutingPlanCustomServicesCustomServiceDefinitionFilter":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"}],"description":"Nested list search by additionalInformation"},"customServiceRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by customServiceRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter":{"properties":{"additionalInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by additionalInformationRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"},"RoutingPlanCustomServicesCustomServiceItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"}],"description":"Nested list search by articleItems"}},"title":"RoutingPlanCustomServicesCustomServiceItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}}}}
```

## The RoutingPlanCustomServicesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanCustomServicesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesListFilter","type":"object","description":"RoutingPlanCustomServicesListFilter"},"RoutingPlanCustomServicesFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsListFilter"}],"description":"Nested list search by articleItems"},"customServiceDefinition":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionFilter"}],"description":"Nested search by customServiceDefinition"},"customServiceItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsListFilter"}],"description":"Nested list search by customServiceItems"}},"title":"RoutingPlanCustomServicesFilter","type":"object","description":"RoutingPlanCustomServicesFilter"},"RoutingPlanCustomServicesArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsListFilter"},"RoutingPlanCustomServicesArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsFilter"},"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"},"RoutingPlanCustomServicesCustomServiceDefinitionFilter":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"}],"description":"Nested list search by additionalInformation"},"customServiceRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by customServiceRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter":{"properties":{"additionalInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by additionalInformationRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"},"RoutingPlanCustomServicesCustomServiceItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"}],"description":"Nested list search by articleItems"}},"title":"RoutingPlanCustomServicesCustomServiceItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}}}}
```

## The RoutingPlanDeliveryPreferencesCollectFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"},"supplyingFacilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by supplyingFacilities"}},"title":"RoutingPlanDeliveryPreferencesCollectFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The RoutingPlanDeliveryPreferencesCollectListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesCollectListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectListFilter"},"RoutingPlanDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"},"supplyingFacilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by supplyingFacilities"}},"title":"RoutingPlanDeliveryPreferencesCollectFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The RoutingPlanDeliveryPreferencesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"},"supplyingFacilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by supplyingFacilities"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanDeliveryPreferencesFilter","type":"object","description":"RoutingPlanDeliveryPreferencesFilter"},"RoutingPlanDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesCollectListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectListFilter"},"RoutingPlanDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"},"supplyingFacilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by supplyingFacilities"}},"title":"RoutingPlanDeliveryPreferencesCollectFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"RoutingPlanDeliveryPreferencesShippingFilter":{"properties":{"preferredCarriers":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by preferredCarriers"},"preferredCarriersWithProduct":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"}],"description":"Nested list search by preferredCarriersWithProduct"}},"title":"RoutingPlanDeliveryPreferencesShippingFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"},"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"}}}}
```

## The RoutingPlanDeliveryPreferencesShippingFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanDeliveryPreferencesShippingFilter":{"properties":{"preferredCarriers":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by preferredCarriers"},"preferredCarriersWithProduct":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"}],"description":"Nested list search by preferredCarriersWithProduct"}},"title":"RoutingPlanDeliveryPreferencesShippingFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"},"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"}}}}
```

## The RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"},"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"}}}}
```

## The RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"},"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"}}}}
```

## The RoutingPlanEarliestPickingStartFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanEarliestPickingStartFilter":{"properties":{"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"earliestPickingStartDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by earliestPickingStartDate"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanEarliestPickingStartFilter","type":"object","description":"RoutingPlanEarliestPickingStartFilter"},"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"},"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"}}}}
```

## The RoutingPlanFailedRerouteWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanFailedRerouteWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/RoutingPlan"}},"required":["payload"],"type":"object","title":"RoutingPlanFailedRerouteWebHookEvent","description":"RoutingPlanFailedRerouteWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlanFallbackRoutingWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanFallbackRoutingWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/RoutingPlan"}},"required":["payload"],"type":"object","title":"RoutingPlanFallbackRoutingWebHookEvent","description":"RoutingPlanFallbackRoutingWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlanHistory object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"}}}}
```

## The RoutingPlanHistoryFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanHistoryFilter":{"properties":{"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"RoutingPlanHistoryFilter","type":"object","description":"RoutingPlanHistoryFilter"},"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"},"RoutingPlanHistoryRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"RoutingPlanHistoryRoutingPlanStatusEnumFilter","type":"object","description":"RoutingPlanHistoryRoutingPlanStatusEnumFilter"}}}}
```

## The RoutingPlanHistoryListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanHistoryListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanHistoryListFilter","type":"object","description":"RoutingPlanHistoryListFilter"},"RoutingPlanHistoryFilter":{"properties":{"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"RoutingPlanHistoryFilter","type":"object","description":"RoutingPlanHistoryFilter"},"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"},"RoutingPlanHistoryRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"RoutingPlanHistoryRoutingPlanStatusEnumFilter","type":"object","description":"RoutingPlanHistoryRoutingPlanStatusEnumFilter"}}}}
```

## The RoutingPlanHistoryRoutingPlanStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanHistoryRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"RoutingPlanHistoryRoutingPlanStatusEnumFilter","type":"object","description":"RoutingPlanHistoryRoutingPlanStatusEnumFilter"}}}}
```

## The RoutingPlanLatestPickingStartFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanLatestPickingStartFilter":{"properties":{"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"latestPickingStartDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by latestPickingStartDate"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanLatestPickingStartFilter","type":"object","description":"RoutingPlanLatestPickingStartFilter"},"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"},"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"}}}}
```

## The RoutingPlanLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"}}}}
```

## The RoutingPlanLineItemPiece object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"}}}}
```

## The RoutingPlanNotRoutableWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanNotRoutableWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/RoutingPlan"}},"required":["payload"],"type":"object","title":"RoutingPlanNotRoutableWebHookEvent","description":"RoutingPlanNotRoutableWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlanOrderLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanOrderLineItemsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"RoutingPlanOrderLineItemsFilter","type":"object","description":"RoutingPlanOrderLineItemsFilter"},"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"}}}}
```

## The RoutingPlanOrderLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanOrderLineItemsListFilter","type":"object","description":"RoutingPlanOrderLineItemsListFilter"},"RoutingPlanOrderLineItemsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"RoutingPlanOrderLineItemsFilter","type":"object","description":"RoutingPlanOrderLineItemsFilter"},"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"}}}}
```

## The RoutingPlanPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"routingPlans":{"items":{"$ref":"#/components/schemas/RoutingPlan"},"type":"array"},"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","routingPlans"],"title":"RoutingPlanPaginatedResult","type":"object","description":"RoutingPlanPaginatedResult"},"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"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlanPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanPatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyRoutingPlanAction"},"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":"RoutingPlanPatchActions"},"title":"RoutingPlanPatchActions","description":"RoutingPlanPatchActions"},"ModifyRoutingPlanAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyRoutingPlan', because you want to modify a routing plan","enum":["ModifyRoutingPlan"],"type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyRoutingPlanAction"},"title":"ModifyRoutingPlanAction","description":"ModifyRoutingPlanAction"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"}}}}
```

## The RoutingPlanRerouteCreatedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanRerouteCreatedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/RoutingPlan"}},"required":["payload"],"type":"object","title":"RoutingPlanRerouteCreatedWebHookEvent","description":"RoutingPlanRerouteCreatedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlanRoutedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanRoutedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/RoutingPlan"}},"required":["payload"],"type":"object","title":"RoutingPlanRoutedWebHookEvent","description":"RoutingPlanRoutedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlans object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlans":{"properties":{"routingPlans":{"items":{"$ref":"#/components/schemas/RoutingPlan"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"RoutingPlans","description":"RoutingPlans"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlanSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanSearchPayload":{"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/RoutingPlanSearchQuery"},"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/RoutingPlanSort"},"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":"RoutingPlanSearchPayload","type":"object","description":"RoutingPlanSearchPayload"},"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"},"RoutingPlanSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/RoutingPlanSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"customServices":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesListFilter"}],"description":"Nested list search by customServices"},"deliveryPreferences":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesFilter"}],"description":"Nested search by deliveryPreferences"},"earliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanEarliestPickingStartFilter"}],"description":"Nested search by earliestPickingStart"},"history":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryListFilter"}],"description":"Nested list search by history"},"latestPickingStart":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanLatestPickingStartFilter"}],"description":"Nested search by latestPickingStart"},"or":{"items":{"$ref":"#/components/schemas/RoutingPlanSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"orderLineItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanOrderLineItemsListFilter"}],"description":"Nested list search by orderLineItems"},"orderRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by orderRef"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"priority":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by priority"},"processId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by processId"},"provisioningTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by provisioningTime"},"reRouteReason":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by reRouteReason"},"splitCount":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by splitCount"},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusEnumFilter"}],"description":"Search by status"},"statusReasons":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsListFilter"}],"description":"Nested list search by statusReasons"},"targetAddress":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanTargetAddressFilter"}],"description":"Nested search by targetAddress"}},"title":"RoutingPlanSearchQuery","type":"object","description":"RoutingPlanSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"RoutingPlanCustomServicesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesListFilter","type":"object","description":"RoutingPlanCustomServicesListFilter"},"RoutingPlanCustomServicesFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsListFilter"}],"description":"Nested list search by articleItems"},"customServiceDefinition":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionFilter"}],"description":"Nested search by customServiceDefinition"},"customServiceItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsListFilter"}],"description":"Nested list search by customServiceItems"}},"title":"RoutingPlanCustomServicesFilter","type":"object","description":"RoutingPlanCustomServicesFilter"},"RoutingPlanCustomServicesArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsListFilter"},"RoutingPlanCustomServicesArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsFilter"},"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"},"RoutingPlanCustomServicesCustomServiceDefinitionFilter":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"}],"description":"Nested list search by additionalInformation"},"customServiceRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by customServiceRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter":{"properties":{"additionalInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by additionalInformationRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"},"RoutingPlanCustomServicesCustomServiceItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"}],"description":"Nested list search by articleItems"}},"title":"RoutingPlanCustomServicesCustomServiceItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"},"RoutingPlanDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"},"supplyingFacilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by supplyingFacilities"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanDeliveryPreferencesFilter","type":"object","description":"RoutingPlanDeliveryPreferencesFilter"},"RoutingPlanDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesCollectListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectListFilter"},"RoutingPlanDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"},"supplyingFacilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by supplyingFacilities"}},"title":"RoutingPlanDeliveryPreferencesCollectFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"RoutingPlanDeliveryPreferencesShippingFilter":{"properties":{"preferredCarriers":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by preferredCarriers"},"preferredCarriersWithProduct":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"}],"description":"Nested list search by preferredCarriersWithProduct"}},"title":"RoutingPlanDeliveryPreferencesShippingFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"},"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"},"RoutingPlanEarliestPickingStartFilter":{"properties":{"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"earliestPickingStartDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by earliestPickingStartDate"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanEarliestPickingStartFilter","type":"object","description":"RoutingPlanEarliestPickingStartFilter"},"RoutingPlanHistoryListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanHistoryListFilter","type":"object","description":"RoutingPlanHistoryListFilter"},"RoutingPlanHistoryFilter":{"properties":{"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"RoutingPlanHistoryFilter","type":"object","description":"RoutingPlanHistoryFilter"},"RoutingPlanHistoryRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"RoutingPlanHistoryRoutingPlanStatusEnumFilter","type":"object","description":"RoutingPlanHistoryRoutingPlanStatusEnumFilter"},"RoutingPlanLatestPickingStartFilter":{"properties":{"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"latestPickingStartDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by latestPickingStartDate"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanLatestPickingStartFilter","type":"object","description":"RoutingPlanLatestPickingStartFilter"},"RoutingPlanOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanOrderLineItemsListFilter","type":"object","description":"RoutingPlanOrderLineItemsListFilter"},"RoutingPlanOrderLineItemsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"RoutingPlanOrderLineItemsFilter","type":"object","description":"RoutingPlanOrderLineItemsFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"RoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"RoutingPlanStatusEnumFilter","type":"object","description":"RoutingPlanStatusEnumFilter"},"RoutingPlanStatusReasonsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanStatusReasonsListFilter","type":"object","description":"RoutingPlanStatusReasonsListFilter"},"RoutingPlanStatusReasonsFilter":{"properties":{"reason":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"}],"description":"Search by reason"},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"}],"description":"Search by status"}},"title":"RoutingPlanStatusReasonsFilter","type":"object","description":"RoutingPlanStatusReasonsFilter"},"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter":{"properties":{"eq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"in":{"description":"Search by reason","items":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"},"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"},"RoutingPlanTargetAddressFilter":{"properties":{"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"RoutingPlanTargetAddressFilter","type":"object","description":"RoutingPlanTargetAddressFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"RoutingPlanSort":{"properties":{"anonymized":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"orderRef":{"enum":["ASC","DESC"],"type":"string"},"processId":{"enum":["ASC","DESC"],"type":"string"},"provisioningTime":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"RoutingPlanSort","type":"object","description":"RoutingPlanSort"}}}}
```

## The RoutingPlanSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/RoutingPlanSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"customServices":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesListFilter"}],"description":"Nested list search by customServices"},"deliveryPreferences":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesFilter"}],"description":"Nested search by deliveryPreferences"},"earliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanEarliestPickingStartFilter"}],"description":"Nested search by earliestPickingStart"},"history":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryListFilter"}],"description":"Nested list search by history"},"latestPickingStart":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanLatestPickingStartFilter"}],"description":"Nested search by latestPickingStart"},"or":{"items":{"$ref":"#/components/schemas/RoutingPlanSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"orderLineItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanOrderLineItemsListFilter"}],"description":"Nested list search by orderLineItems"},"orderRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by orderRef"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"priority":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by priority"},"processId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by processId"},"provisioningTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by provisioningTime"},"reRouteReason":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by reRouteReason"},"splitCount":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by splitCount"},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusEnumFilter"}],"description":"Search by status"},"statusReasons":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsListFilter"}],"description":"Nested list search by statusReasons"},"targetAddress":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanTargetAddressFilter"}],"description":"Nested search by targetAddress"}},"title":"RoutingPlanSearchQuery","type":"object","description":"RoutingPlanSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"RoutingPlanCustomServicesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesListFilter","type":"object","description":"RoutingPlanCustomServicesListFilter"},"RoutingPlanCustomServicesFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsListFilter"}],"description":"Nested list search by articleItems"},"customServiceDefinition":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionFilter"}],"description":"Nested search by customServiceDefinition"},"customServiceItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsListFilter"}],"description":"Nested list search by customServiceItems"}},"title":"RoutingPlanCustomServicesFilter","type":"object","description":"RoutingPlanCustomServicesFilter"},"RoutingPlanCustomServicesArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsListFilter"},"RoutingPlanCustomServicesArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesArticleItemsFilter"},"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"},"RoutingPlanCustomServicesCustomServiceDefinitionFilter":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"}],"description":"Nested list search by additionalInformation"},"customServiceRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by customServiceRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter"},"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter":{"properties":{"additionalInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by additionalInformationRef"}},"title":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter"},"RoutingPlanCustomServicesCustomServiceItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsFilter":{"properties":{"articleItems":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"}],"description":"Nested list search by articleItems"}},"title":"RoutingPlanCustomServicesCustomServiceItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter"},"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter":{"properties":{"tenantArticleRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleRef"}},"title":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter","type":"object","description":"RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter"},"RoutingPlanDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"},"supplyingFacilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by supplyingFacilities"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanDeliveryPreferencesFilter","type":"object","description":"RoutingPlanDeliveryPreferencesFilter"},"RoutingPlanDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesCollectListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectListFilter"},"RoutingPlanDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"},"supplyingFacilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by supplyingFacilities"}},"title":"RoutingPlanDeliveryPreferencesCollectFilter","type":"object","description":"RoutingPlanDeliveryPreferencesCollectFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"RoutingPlanDeliveryPreferencesShippingFilter":{"properties":{"preferredCarriers":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by preferredCarriers"},"preferredCarriersWithProduct":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"}],"description":"Nested list search by preferredCarriersWithProduct"}},"title":"RoutingPlanDeliveryPreferencesShippingFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter"},"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"}},"title":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter","type":"object","description":"RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter"},"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"},"RoutingPlanEarliestPickingStartFilter":{"properties":{"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"earliestPickingStartDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by earliestPickingStartDate"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanEarliestPickingStartFilter","type":"object","description":"RoutingPlanEarliestPickingStartFilter"},"RoutingPlanHistoryListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanHistoryListFilter","type":"object","description":"RoutingPlanHistoryListFilter"},"RoutingPlanHistoryFilter":{"properties":{"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanHistoryRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"RoutingPlanHistoryFilter","type":"object","description":"RoutingPlanHistoryFilter"},"RoutingPlanHistoryRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"RoutingPlanHistoryRoutingPlanStatusEnumFilter","type":"object","description":"RoutingPlanHistoryRoutingPlanStatusEnumFilter"},"RoutingPlanLatestPickingStartFilter":{"properties":{"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"latestPickingStartDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by latestPickingStartDate"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"RoutingPlanLatestPickingStartFilter","type":"object","description":"RoutingPlanLatestPickingStartFilter"},"RoutingPlanOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanOrderLineItemsListFilter","type":"object","description":"RoutingPlanOrderLineItemsListFilter"},"RoutingPlanOrderLineItemsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"RoutingPlanOrderLineItemsFilter","type":"object","description":"RoutingPlanOrderLineItemsFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"RoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"RoutingPlanStatusEnumFilter","type":"object","description":"RoutingPlanStatusEnumFilter"},"RoutingPlanStatusReasonsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanStatusReasonsListFilter","type":"object","description":"RoutingPlanStatusReasonsListFilter"},"RoutingPlanStatusReasonsFilter":{"properties":{"reason":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"}],"description":"Search by reason"},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"}],"description":"Search by status"}},"title":"RoutingPlanStatusReasonsFilter","type":"object","description":"RoutingPlanStatusReasonsFilter"},"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter":{"properties":{"eq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"in":{"description":"Search by reason","items":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"},"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"},"RoutingPlanTargetAddressFilter":{"properties":{"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"RoutingPlanTargetAddressFilter","type":"object","description":"RoutingPlanTargetAddressFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"}}}}
```

## The RoutingPlansGraph object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlansGraph":{"additionalProperties":false,"description":"A graph representation of the routing plans. The nodes are the routing plans and the edges are the rerouting reasons.","properties":{"edges":{"items":{"$ref":"#/components/schemas/RoutingPlansGraphEdge"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/RoutingPlansGraphNode"},"type":"array"}},"required":["nodes","edges"],"title":"RoutingPlansGraph"},"RoutingPlansGraphEdge":{"additionalProperties":false,"properties":{"from":{"type":"string"},"reason":{"$ref":"#/components/schemas/RoutingPlansGraphEdgeReason"},"to":{"type":"string"}},"required":["from","to","reason"],"type":"object","title":"RoutingPlansGraphEdge","description":"RoutingPlansGraphEdge"},"RoutingPlansGraphEdgeReason":{"enum":["SPLIT","REROUTE","INTER_FACILITY_TRANSFER"],"type":"string","title":"RoutingPlansGraphEdgeReason","description":"RoutingPlansGraphEdgeReason"},"RoutingPlansGraphNode":{"additionalProperties":false,"properties":{"routingPlanRef":{"type":"string"}},"required":["routingPlanRef"],"type":"object","title":"RoutingPlansGraphNode","description":"RoutingPlansGraphNode"}}}}
```

## The RoutingPlansGraphEdge object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlansGraphEdge":{"additionalProperties":false,"properties":{"from":{"type":"string"},"reason":{"$ref":"#/components/schemas/RoutingPlansGraphEdgeReason"},"to":{"type":"string"}},"required":["from","to","reason"],"type":"object","title":"RoutingPlansGraphEdge","description":"RoutingPlansGraphEdge"},"RoutingPlansGraphEdgeReason":{"enum":["SPLIT","REROUTE","INTER_FACILITY_TRANSFER"],"type":"string","title":"RoutingPlansGraphEdgeReason","description":"RoutingPlansGraphEdgeReason"}}}}
```

## The RoutingPlansGraphEdgeReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlansGraphEdgeReason":{"enum":["SPLIT","REROUTE","INTER_FACILITY_TRANSFER"],"type":"string","title":"RoutingPlansGraphEdgeReason","description":"RoutingPlansGraphEdgeReason"}}}}
```

## The RoutingPlansGraphNode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlansGraphNode":{"additionalProperties":false,"properties":{"routingPlanRef":{"type":"string"}},"required":["routingPlanRef"],"type":"object","title":"RoutingPlansGraphNode","description":"RoutingPlansGraphNode"}}}}
```

## The RoutingPlanSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanSort":{"properties":{"anonymized":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"orderRef":{"enum":["ASC","DESC"],"type":"string"},"processId":{"enum":["ASC","DESC"],"type":"string"},"provisioningTime":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"RoutingPlanSort","type":"object","description":"RoutingPlanSort"}}}}
```

## The RoutingPlanSplittedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanSplittedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/RoutingPlan"}},"required":["payload"],"type":"object","title":"RoutingPlanSplittedWebHookEvent","description":"RoutingPlanSplittedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingPlanStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"}}}}
```

## The RoutingPlanStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"RoutingPlanStatusEnumFilter","type":"object","description":"RoutingPlanStatusEnumFilter"}}}}
```

## The RoutingPlanStatusReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"}}}}
```

## The RoutingPlanStatusReasonReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"}}}}
```

## The RoutingPlanStatusReasonsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatusReasonsFilter":{"properties":{"reason":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"}],"description":"Search by reason"},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"}],"description":"Search by status"}},"title":"RoutingPlanStatusReasonsFilter","type":"object","description":"RoutingPlanStatusReasonsFilter"},"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter":{"properties":{"eq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"in":{"description":"Search by reason","items":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"},"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"}}}}
```

## The RoutingPlanStatusReasonsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatusReasonsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"RoutingPlanStatusReasonsListFilter","type":"object","description":"RoutingPlanStatusReasonsListFilter"},"RoutingPlanStatusReasonsFilter":{"properties":{"reason":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"}],"description":"Search by reason"},"status":{"allOf":[{"$ref":"#/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"}],"description":"Search by status"}},"title":"RoutingPlanStatusReasonsFilter","type":"object","description":"RoutingPlanStatusReasonsFilter"},"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter":{"properties":{"eq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"in":{"description":"Search by reason","items":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"},"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"}}}}
```

## The RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter":{"properties":{"eq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"in":{"description":"Search by reason","items":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by reason","enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter"}}}}
```

## The RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OBSOLETE"],"type":"string"}},"title":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter","type":"object","description":"RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter"}}}}
```

## The RoutingPlanStatusReasonStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"}}}}
```

## The RoutingPlanTargetAddressFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanTargetAddressFilter":{"properties":{"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"RoutingPlanTargetAddressFilter","type":"object","description":"RoutingPlanTargetAddressFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"}}}}
```

## The RoutingPlanWaitingWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingPlanWaitingWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/RoutingPlan"}},"required":["payload"],"type":"object","title":"RoutingPlanWaitingWebHookEvent","description":"RoutingPlanWaitingWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"RoutingPlan":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"activeConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"childRoutingPlanRef":{"type":"string"},"consolidatedStatus":{"$ref":"#/components/schemas/ConsolidatedRoutingPlanStatus"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"decisionLogs":{"items":{"$ref":"#/components/schemas/DecisionLogRef"},"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"earliestPickingStart":{"$ref":"#/components/schemas/EarliestPickingStart"},"expectedLineItems":{"items":{"$ref":"#/components/schemas/ExpectedLineItem"},"type":"array"},"facilityBlackList":{"items":{"description":"Contains a list of facilities to ignore when rerouting happens.","type":"string"},"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"fallbackRoutingAfterTimeInSeconds":{"description":"In case this routing plan has an active fallback facility configuration, this is the time in seconds after which the fallback routing will be attempted.","type":"number"},"finalizeRun":{"description":"The iteration through the finalizer process","minimum":0,"type":"number"},"firstRoutingAttempt":{"description":"The date of the first routing attempt.","format":"date-time","type":"string"},"history":{"items":{"$ref":"#/components/schemas/RoutingPlanHistory"},"type":"array"},"id":{"type":"string"},"latestPickingStart":{"$ref":"#/components/schemas/LatestPickingStart"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/RoutingPlanLineItem"},"type":"array"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"parentRoutingPlanRef":{"type":"string"},"pickJobRef":{"description":"The id of the pickjob that has been created from the routing plan.","type":"string"},"predecessorRerouteRoutingPlanRefs":{"description":"Refs of the predecessor routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"priority":{"description":"priority of return plan","minimum":0,"type":"number"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescription"},"reRoutedFacilityRef":{"description":"The id of the facility the order was rerouted from.","type":"string"},"reRoutedPickJobRef":{"description":"The id of the original pickjob that was rerouted.","type":"string"},"reRoutedRoutingPlanRef":{"description":"The id of the original routingplan that was rerouted.","type":"string"},"reRouteReason":{"$ref":"#/components/schemas/RerouteReason"},"routingRun":{"description":"The iteration through the routing process","type":"number"},"runId":{"description":"ID of the routing run this plan was created in","type":"string"},"runType":{"description":"The rule type of a decision log entry","enum":["DEFAULT","REROUTE","ORDERSPLIT_ON_SHORTPICK","MANUAL_ASSIGNMENT","PROCESS_MANUALASSIGNMENT","REACTIVATION"],"type":"string"},"splitCount":{"default":0,"description":"The number of order splits that happened before this routingplan was created","minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"},"statusHistory":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated\n For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan","items":{"$ref":"#/components/schemas/RoutingPlanStatus"},"type":"array"},"statusReasons":{"items":{"$ref":"#/components/schemas/RoutingPlanStatusReason"},"type":"array"},"strandId":{"description":"The id of the sourcing option strand this plan has been derived from.","type":"string"},"successorRerouteRoutingPlanRefs":{"description":"Refs of the succeeding routing plans, in the case of a reroute.","items":{"type":"string"},"type":"array"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"},"targetAddressesByDeliveryEvent":{"items":{"$ref":"#/components/schemas/DeliveryEventTargetAddress"},"type":"array"},"targetTimeBaseDate":{"description":"This date is used as base/start to calculate the target time date.","format":"date-time","type":"string"},"tenantOrderId":{"description":"The id of the order in the tenant system that lead to the creation of this routingplan.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","orderDate","created","lastModified","version","orderRef","priority","status","consolidatedStatus","decisionLogs","routingRun","finalizeRun","processId","predecessorRerouteRoutingPlanRefs","successorRerouteRoutingPlanRefs","workflowInformation"],"type":"object","title":"RoutingPlan","description":"RoutingPlan"},"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"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"ConsolidatedRoutingPlanStatus":{"description":"This status consolidates many of the RoutingPlanStatus and offers\na more detailes explanation of what happened to the routing plan.","enum":["REROUTED","MANUALLY_REROUTED","ORDER_MODIFIED_REROUTED","PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE","PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT","PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED","ROUTED","ROUTED_THEN_REROUTED","PROCESS_MANUAL_REROUTED_THEN_ROUTED","PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY","ROUTING_PLAN_CREATED_THEN_ROUTING","ROUTING_PLAN_CREATED_THEN_PLANNED","ROUTING_PLAN_REROUTED_THEN_FAILED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED","STOCK_UPDATE_RECEIVED_THEN_REACTIVATED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT","ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY","PICKJOB_REJECTED_THEN_REROUTED","PICKJOB_REJECTED_THEN_NOT_ROUTABLE","PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT","ROUTED_AND_SPLIT","OBSOLETE","OBSOLETE_WAS_MANUALLY_REROUTED","OBSOLETE_WAS_MANUALLY_ASSIGNED","OBSOLETE_WAS_SHORTPICKED","OBSOLETE_WAS_ROUTED","UNKNOWN","RETRYABLE","FAILED_REROUTE","ROUTED_THEN_CANCELED","ROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED","ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED","FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED","PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED","CANCELED","NOT_ROUTABLE","NOT_ROUTABLE_WAS_MANUALLY_REROUTED","NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED","WAITING","WAITING_WAS_MANUALLY_REROUTED","WAITING_WAS_MANUALLY_ASSIGNED","WAITING_AND_SPLIT","WAITING_THEN_ROUTED","WAITING_THEN_ROUTED_AND_SPLIT","WAITING_THEN_NOT_ROUTABLE","WAITING_THEN_WAITING_AND_SPLIT","LOCKED","INITIAL"],"type":"string","xml":{"name":"RealRoutingPlanStatus"},"title":"ConsolidatedRoutingPlanStatus"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DecisionLogRef":{"properties":{"routingRun":{"type":"number"},"url":{"description":"A reference to the finalizer decision log","type":"string"}},"required":["url","finalizeRun"],"type":"object","xml":{"name":"DecisionLogRef"},"title":"DecisionLogRef","description":"DecisionLogRef"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"EarliestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"earliestPickingStartDate":{"format":"date-time","type":"string"}},"required":["earliestPickingStartDate"],"type":"object","title":"EarliestPickingStart","description":"EarliestPickingStart"},"PickingStartBase":{"properties":{"carrierRef":{"type":"string"},"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","title":"PickingStartBase","description":"PickingStartBase"},"ExpectedLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"facilityRef":{"type":"string"},"transferId":{"type":"string"}},"required":["facilityRef","transferId"],"title":"ExpectedLineItem","description":"ExpectedLineItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RoutingPlanHistory":{"properties":{"created":{"description":"Information about the time, when a routing plan status is set","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["status","created"],"title":"RoutingPlanHistory","description":"RoutingPlanHistory"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"},"LatestPickingStart":{"allOf":[{"$ref":"#/components/schemas/PickingStartBase"}],"properties":{"latestPickingStartDate":{"format":"date-time","type":"string"}},"required":["latestPickingStartDate"],"type":"object","title":"LatestPickingStart","description":"LatestPickingStart"},"RoutingPlanLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItem"}],"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"picked":{"type":"number"},"pieces":{"description":"@deprecated This property has been deprecated and has no meaning.","items":{"$ref":"#/components/schemas/RoutingPlanLineItemPiece"},"type":"array"}},"title":"RoutingPlanLineItem","description":"RoutingPlanLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"RoutingPlanLineItemPiece":{"properties":{"available":{"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"mandatoryScore":{"type":"number"},"partialStockRef":{"type":"string"},"picked":{"type":"number"},"quantity":{"type":"number"},"sequenceScore":{"type":"number"}},"type":"object","title":"RoutingPlanLineItemPiece","description":"RoutingPlanLineItemPiece"},"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"},"RerouteDescription":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["REROUTE"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"RerouteDescription"},"title":"RerouteDescription","description":"RerouteDescription"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"RerouteReason":{"enum":["ORDERMODIFIED","PROCESSREROUTE","MANUAL","SHORTPICK","TIMETRIGGERED","STOCKZEROED","ABORTED","RECALCULATION"],"type":"string","title":"RerouteReason","description":"RerouteReason"},"RoutingPlanStatusReason":{"description":"Obsolete Status Reason","properties":{"reason":{"$ref":"#/components/schemas/RoutingPlanStatusReasonReason"},"status":{"$ref":"#/components/schemas/RoutingPlanStatusReasonStatus"}},"required":["reason","status"],"title":"RoutingPlanStatusReason"},"RoutingPlanStatusReasonReason":{"enum":["REROUTE_AFTER_SHORTPICK","MANUALLY_REROUTED","MANUALLY_ASSIGNED","ORDER_MODIFIED"],"type":"string","title":"RoutingPlanStatusReasonReason","description":"RoutingPlanStatusReasonReason"},"RoutingPlanStatusReasonStatus":{"enum":["OBSOLETE"],"type":"string","title":"RoutingPlanStatusReasonStatus","description":"RoutingPlanStatusReasonStatus"},"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"},"DeliveryEventTargetAddress":{"properties":{"deliveryEvent":{"$ref":"#/components/schemas/DeliveryEvent"},"facilityRef":{"type":"string"},"targetAddress":{"$ref":"#/components/schemas/TargetAddress"}},"required":["facilityRef","targetAddress","deliveryEvent"],"type":"object","title":"DeliveryEventTargetAddress","description":"DeliveryEventTargetAddress"},"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The RoutingResults object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingResults":{"properties":{"assignedItems":{"items":{"$ref":"#/components/schemas/AssignmentItem"},"type":"array"},"bestAvailableFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"bestRatedFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"bestReassignmentFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"routingPlanStatus":{"$ref":"#/components/schemas/RoutingPlanStatus"}},"required":["assignedItems"],"title":"RoutingResults","description":"RoutingResults"},"AssignmentItem":{"properties":{"articleTitle":{"type":"string"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"AssignmentItem","description":"AssignmentItem"},"DecisionLogFacilityInfo":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"required":["name","facilityRef"],"title":"DecisionLogFacilityInfo","description":"DecisionLogFacilityInfo"},"RoutingPlanStatus":{"description":"A routing plan line initially has the status INITIAL. Final state is ROUTED","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string","xml":{"name":"RoutingPlanStatus"},"title":"RoutingPlanStatus"}}}}
```

## The RoutingRule object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingRule":{"additionalProperties":false,"properties":{"fences":{"items":{"$ref":"#/components/schemas/Fence"},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/OrderSplit"},"ratings":{"items":{"$ref":"#/components/schemas/Rating"},"type":"array"}},"required":["ratings","fences"],"type":"object","title":"RoutingRule","description":"RoutingRule"},"Fence":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"id":{"description":"This value identifies this very instance of the fence. It is set autmatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"}},"required":["active","implementation","id"],"type":"object","title":"Fence","description":"Fence"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"OrderSplit":{"additionalProperties":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","properties":{"active":{"default":false,"type":"boolean"},"activeForSameDay":{"default":false,"type":"boolean"},"fixedCountConfiguration":{"$ref":"#/components/schemas/FixedCountConfiguration"},"orderSplitType":{"$ref":"#/components/schemas/OrderSplitType"},"shouldUseWaitingRoomForPreBackOrderItems":{"default":false,"type":"boolean"}},"required":["active","orderSplitType"],"type":"object","title":"OrderSplit"},"FixedCountConfiguration":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration of fixed count split.","properties":{"maxSplitCount":{"description":"This setting defines how often an order split might be performed to fulfill the order.","minimum":1,"type":"number"}},"required":["maxSplitCount"],"type":"object","title":"FixedCountConfiguration"},"OrderSplitType":{"description":"The type of order split","enum":["FIXED_COUNT"],"type":"string","xml":{"name":"OrderSplitType"},"title":"OrderSplitType"},"Rating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"id":{"description":"This value identifies this very instance of the rating. It is set automatically by the server when the configuration is updated.","type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"}},"required":["name","active","implementation","maxPenalty","id"],"type":"object","title":"Rating"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"}}}}
```

## The RoutingStatistics object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStatistics":{"properties":{"durationMs":{"type":"number"},"fenceStatistics":{"items":{"$ref":"#/components/schemas/FenceStatistic"},"type":"array"},"ratingStatistics":{"items":{"$ref":"#/components/schemas/RatingStatistic"},"type":"array"}},"required":["fenceStatistics","ratingStatistics","lineItemFenceStatistics"],"title":"RoutingStatistics","description":"RoutingStatistics"},"FenceStatistic":{"properties":{"durationMs":{"description":"Duration in Milliseconds","type":"number"},"name":{"type":"string"},"passedAmount":{"type":"number"},"passedPercentage":{"type":"number"},"rejectedAmount":{"type":"number"}},"required":["name","rejectedAmount","passedAmount","passedPercentage","durationMs"],"title":"FenceStatistic","description":"FenceStatistic"},"RatingStatistic":{"properties":{"durationMs":{"description":"Duration in Milliseconds","type":"number"},"maxPenalty":{"type":"number"},"maxScore":{"type":"number"},"minScore":{"type":"number"},"name":{"type":"string"}},"required":["name","maxPenalty","durationMs"],"title":"RatingStatistic","description":"RatingStatistic"}}}}
```

## The RoutingStrategy object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategy":{"additionalProperties":true,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"globalConfiguration":{"$ref":"#/components/schemas/RoutingStrategyGlobalConfiguration"},"id":{"type":"string"},"inUse":{"description":"Only one strategy can be inUse","type":"boolean"},"name":{"type":"string"},"revision":{"description":"The revision of the routing strategy","type":"integer"},"rootNode":{"$ref":"#/components/schemas/RoutingStrategyNode"}},"required":["inUse","revision","id","nameLocalized","rootNode","globalConfiguration"]}],"type":"object","title":"RoutingStrategy","description":"RoutingStrategy"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"RoutingStrategyGlobalConfiguration":{"additionalProperties":false,"properties":{"blacklistAssignedFacilities":{"description":"If true, facilities that have already been assigned to the order in a previous routing attempt will not be considered in the next routing attempt.","type":"boolean"},"defaultPrice":{"default":10,"description":"The price applied when no specific price is defined in the order or listing","type":"number"},"restowAfterMinutes":{"description":"The amount of minutes after which a restow is executed. If not set, restows will not be executed.","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"The amount of time, specified in ISO 8601 duration format, after which a routing plan is considered not routable. Note: The duration must be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"timeTriggeredByContext":{"items":{"$ref":"#/components/schemas/TimeTriggeredConfigurationContext"},"maxItems":500,"type":"array"}},"required":["defaultPrice"],"type":"object","xml":{"name":"RoutingStrategyGlobalConfiguration"},"title":"RoutingStrategyGlobalConfiguration","description":"RoutingStrategyGlobalConfiguration"},"RoutingStrategyRerouteTimeTriggeredConfig":{"additionalProperties":false,"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"type":"object","title":"RoutingStrategyRerouteTimeTriggeredConfig","description":"RoutingStrategyRerouteTimeTriggeredConfig"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"},"TimeTriggeredConfigurationContext":{"additionalProperties":false,"properties":{"priority":{"minimum":0,"type":"number"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"type":{"$ref":"#/components/schemas/TimeTriggeredConfigContextType"},"values":{"description":"The id of the context values. For example, if the type is FACILITY, then the values are the ids of the facilities.","items":{"format":"uuid","type":"string"},"maxItems":500,"type":"array"}},"required":["priority","type","values","timeTriggered"],"type":"object","title":"TimeTriggeredConfigurationContext","description":"TimeTriggeredConfigurationContext"},"TimeTriggeredConfigContextType":{"enum":["FACILITY","FACILITY_GROUP"],"type":"string","title":"TimeTriggeredConfigContextType","description":"TimeTriggeredConfigContextType"},"RoutingStrategyNode":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyCondition"}},"required":["active","config","id","nameLocalized"],"type":"object","title":"RoutingStrategyNode","description":"RoutingStrategyNode"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyCondition":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyCondition"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNode"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","id","nameLocalized"],"title":"RoutingStrategyCondition","description":"RoutingStrategyCondition"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyActionsParameter":{"oneOf":[{"$ref":"#/components/schemas/RoutingStrategyActivateActionParameter"},{"$ref":"#/components/schemas/RoutingStrategyCreateCopyActionParameter"},{"$ref":"#/components/schemas/RoutingStrategyReplaceGlobalConfigurationActionParameter"},{"$ref":"#/components/schemas/RoutingStrategyReplaceNodeActionParameter"},{"$ref":"#/components/schemas/RoutingStrategyReplaceConditionActionParameter"}],"title":"RoutingStrategyActionsParameter","description":"RoutingStrategyActionsParameter"},"RoutingStrategyActivateActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to activate a routing strategy.","properties":{"name":{"enum":["ACTIVATE"],"type":"string"}},"required":["name","version"],"title":"RoutingStrategyActivateActionParameter"},"AbstractRoutingStrategyActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractRoutingStrategyActionsParameter","description":"AbstractRoutingStrategyActionsParameter"},"RoutingStrategyCreateCopyActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to create a copy of a routing strategy.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"enum":["COPY"],"type":"string"}},"required":["name","nameLocalized","version"],"title":"RoutingStrategyCreateCopyActionParameter"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"RoutingStrategyReplaceGlobalConfigurationActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to replace the global configuration of a routing strategy.","properties":{"globalConfiguration":{"$ref":"#/components/schemas/RoutingStrategyGlobalConfiguration"},"name":{"enum":["REPLACE_GLOBAL_CONFIGURATION"],"type":"string"}},"required":["name","globalConfiguration","version"],"title":"RoutingStrategyReplaceGlobalConfigurationActionParameter"},"RoutingStrategyGlobalConfiguration":{"additionalProperties":false,"properties":{"blacklistAssignedFacilities":{"description":"If true, facilities that have already been assigned to the order in a previous routing attempt will not be considered in the next routing attempt.","type":"boolean"},"defaultPrice":{"default":10,"description":"The price applied when no specific price is defined in the order or listing","type":"number"},"restowAfterMinutes":{"description":"The amount of minutes after which a restow is executed. If not set, restows will not be executed.","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"The amount of time, specified in ISO 8601 duration format, after which a routing plan is considered not routable. Note: The duration must be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"timeTriggeredByContext":{"items":{"$ref":"#/components/schemas/TimeTriggeredConfigurationContext"},"maxItems":500,"type":"array"}},"required":["defaultPrice"],"type":"object","xml":{"name":"RoutingStrategyGlobalConfiguration"},"title":"RoutingStrategyGlobalConfiguration","description":"RoutingStrategyGlobalConfiguration"},"RoutingStrategyRerouteTimeTriggeredConfig":{"additionalProperties":false,"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"type":"object","title":"RoutingStrategyRerouteTimeTriggeredConfig","description":"RoutingStrategyRerouteTimeTriggeredConfig"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"},"TimeTriggeredConfigurationContext":{"additionalProperties":false,"properties":{"priority":{"minimum":0,"type":"number"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"type":{"$ref":"#/components/schemas/TimeTriggeredConfigContextType"},"values":{"description":"The id of the context values. For example, if the type is FACILITY, then the values are the ids of the facilities.","items":{"format":"uuid","type":"string"},"maxItems":500,"type":"array"}},"required":["priority","type","values","timeTriggered"],"type":"object","title":"TimeTriggeredConfigurationContext","description":"TimeTriggeredConfigurationContext"},"TimeTriggeredConfigContextType":{"enum":["FACILITY","FACILITY_GROUP"],"type":"string","title":"TimeTriggeredConfigContextType","description":"TimeTriggeredConfigContextType"},"RoutingStrategyReplaceNodeActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to replace a node of a routing strategy.","properties":{"name":{"enum":["REPLACE_NODE"],"type":"string"},"node":{"$ref":"#/components/schemas/RoutingStrategyNodeForReplace"},"nodeId":{"type":"string"}},"required":["name","nodeId","node","version"],"title":"RoutingStrategyReplaceNodeActionParameter"},"RoutingStrategyNodeForReplace":{"additionalProperties":false,"description":"Node data for replacing a node in a routing strategy.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigForUpsert"}},"required":["active","nameLocalized","config"],"title":"RoutingStrategyNodeForReplace"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyReplaceConditionActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to replace a condition of a routing strategy.","properties":{"condition":{"$ref":"#/components/schemas/RoutingStrategyConditionForReplace"},"conditionId":{"type":"string"},"name":{"enum":["REPLACE_CONDITION"],"type":"string"}},"required":["name","conditionId","condition","version"],"title":"RoutingStrategyReplaceConditionActionParameter"},"RoutingStrategyConditionForReplace":{"additionalProperties":false,"description":"Condition data for replacing a condition in a routing strategy.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["active","nameLocalized","rule"],"title":"RoutingStrategyConditionForReplace"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyActivateActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyActivateActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to activate a routing strategy.","properties":{"name":{"enum":["ACTIVATE"],"type":"string"}},"required":["name","version"],"title":"RoutingStrategyActivateActionParameter"},"AbstractRoutingStrategyActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractRoutingStrategyActionsParameter","description":"AbstractRoutingStrategyActionsParameter"}}}}
```

## The RoutingStrategyCondition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyCondition":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyCondition"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNode"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","id","nameLocalized"],"title":"RoutingStrategyCondition","description":"RoutingStrategyCondition"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNode":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyCondition"}},"required":["active","config","id","nameLocalized"],"type":"object","title":"RoutingStrategyNode","description":"RoutingStrategyNode"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyConditionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyConditionForCreation":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForCreation"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNodeForCreation"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","nameLocalized"],"title":"RoutingStrategyConditionForCreation","description":"RoutingStrategyConditionForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeForCreation":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigForUpsert"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForCreation"}},"required":["active","config","nameLocalized"],"type":"object","title":"RoutingStrategyNodeForCreation","description":"RoutingStrategyNodeForCreation"},"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyConditionForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyConditionForModification":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForModification"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNodeForModification"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","nameLocalized"],"title":"RoutingStrategyConditionForModification","description":"RoutingStrategyConditionForModification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeForModification":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigForUpsert"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForModification"}},"required":["active","config","nameLocalized"],"type":"object","title":"RoutingStrategyNodeForModification","description":"RoutingStrategyNodeForModification"},"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyConditionForReplace object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyConditionForReplace":{"additionalProperties":false,"description":"Condition data for replacing a condition in a routing strategy.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["active","nameLocalized","rule"],"title":"RoutingStrategyConditionForReplace"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The RoutingStrategyConditionPredicate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The RoutingStrategyConditionRule object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The RoutingStrategyCreateCopyActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyCreateCopyActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to create a copy of a routing strategy.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"enum":["COPY"],"type":"string"}},"required":["name","nameLocalized","version"],"title":"RoutingStrategyCreateCopyActionParameter"},"AbstractRoutingStrategyActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractRoutingStrategyActionsParameter","description":"AbstractRoutingStrategyActionsParameter"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RoutingStrategyEvaluationResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyEvaluationResult":{"properties":{"evaluatedConfig":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"evaluatedPath":{"items":{"$ref":"#/components/schemas/RoutingStrategyPathElement"},"type":"array"}},"required":["evaluatedConfig","evaluatedPath"],"type":"object","title":"RoutingStrategyEvaluationResult","description":"RoutingStrategyEvaluationResult"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyPathElement":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"evaluationResult":{"$ref":"#/components/schemas/RoutingStrategyEvaluationResultType"},"ref":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyPathElementType"}},"required":["type","ref","evaluationResult","nameLocalized"],"type":"object","title":"RoutingStrategyPathElement","description":"RoutingStrategyPathElement"},"RoutingStrategyEvaluationResultType":{"enum":["NODE_INACTIVE","NODE_ACTIVE","CONDITION_INACTIVE","CONDITION_FALSE","CONDITION_TRUE"],"type":"string","title":"RoutingStrategyEvaluationResultType","description":"RoutingStrategyEvaluationResultType"},"RoutingStrategyPathElementType":{"enum":["CONDITION","NODE"],"type":"string","title":"RoutingStrategyPathElementType","description":"RoutingStrategyPathElementType"}}}}
```

## The RoutingStrategyEvaluationResultType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyEvaluationResultType":{"enum":["NODE_INACTIVE","NODE_ACTIVE","CONDITION_INACTIVE","CONDITION_FALSE","CONDITION_TRUE"],"type":"string","title":"RoutingStrategyEvaluationResultType","description":"RoutingStrategyEvaluationResultType"}}}}
```

## The RoutingStrategyFacilityRerouteConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"}}}}
```

## The RoutingStrategyFallbackFacilityConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"}}}}
```

## The RoutingStrategyForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyForCreation":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"}},"required":["nameLocalized"],"type":"object","xml":{"name":"RoutingStrategy"},"title":"RoutingStrategyForCreation","description":"RoutingStrategyForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RoutingStrategyForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyForModification":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"globalConfiguration":{"$ref":"#/components/schemas/RoutingStrategyGlobalConfiguration"},"rootNode":{"$ref":"#/components/schemas/RoutingStrategyNodeForModification"},"version":{"type":"integer"}},"required":["rootNode","nameLocalized","version"],"xml":{"name":"RoutingStrategyForModification"},"title":"RoutingStrategyForModification","description":"RoutingStrategyForModification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"RoutingStrategyGlobalConfiguration":{"additionalProperties":false,"properties":{"blacklistAssignedFacilities":{"description":"If true, facilities that have already been assigned to the order in a previous routing attempt will not be considered in the next routing attempt.","type":"boolean"},"defaultPrice":{"default":10,"description":"The price applied when no specific price is defined in the order or listing","type":"number"},"restowAfterMinutes":{"description":"The amount of minutes after which a restow is executed. If not set, restows will not be executed.","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"The amount of time, specified in ISO 8601 duration format, after which a routing plan is considered not routable. Note: The duration must be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"timeTriggeredByContext":{"items":{"$ref":"#/components/schemas/TimeTriggeredConfigurationContext"},"maxItems":500,"type":"array"}},"required":["defaultPrice"],"type":"object","xml":{"name":"RoutingStrategyGlobalConfiguration"},"title":"RoutingStrategyGlobalConfiguration","description":"RoutingStrategyGlobalConfiguration"},"RoutingStrategyRerouteTimeTriggeredConfig":{"additionalProperties":false,"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"type":"object","title":"RoutingStrategyRerouteTimeTriggeredConfig","description":"RoutingStrategyRerouteTimeTriggeredConfig"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"},"TimeTriggeredConfigurationContext":{"additionalProperties":false,"properties":{"priority":{"minimum":0,"type":"number"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"type":{"$ref":"#/components/schemas/TimeTriggeredConfigContextType"},"values":{"description":"The id of the context values. For example, if the type is FACILITY, then the values are the ids of the facilities.","items":{"format":"uuid","type":"string"},"maxItems":500,"type":"array"}},"required":["priority","type","values","timeTriggered"],"type":"object","title":"TimeTriggeredConfigurationContext","description":"TimeTriggeredConfigurationContext"},"TimeTriggeredConfigContextType":{"enum":["FACILITY","FACILITY_GROUP"],"type":"string","title":"TimeTriggeredConfigContextType","description":"TimeTriggeredConfigContextType"},"RoutingStrategyNodeForModification":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigForUpsert"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForModification"}},"required":["active","config","nameLocalized"],"type":"object","title":"RoutingStrategyNodeForModification","description":"RoutingStrategyNodeForModification"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyConditionForModification":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForModification"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNodeForModification"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","nameLocalized"],"title":"RoutingStrategyConditionForModification","description":"RoutingStrategyConditionForModification"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyGlobalConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyGlobalConfiguration":{"additionalProperties":false,"properties":{"blacklistAssignedFacilities":{"description":"If true, facilities that have already been assigned to the order in a previous routing attempt will not be considered in the next routing attempt.","type":"boolean"},"defaultPrice":{"default":10,"description":"The price applied when no specific price is defined in the order or listing","type":"number"},"restowAfterMinutes":{"description":"The amount of minutes after which a restow is executed. If not set, restows will not be executed.","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"The amount of time, specified in ISO 8601 duration format, after which a routing plan is considered not routable. Note: The duration must be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"timeTriggeredByContext":{"items":{"$ref":"#/components/schemas/TimeTriggeredConfigurationContext"},"maxItems":500,"type":"array"}},"required":["defaultPrice"],"type":"object","xml":{"name":"RoutingStrategyGlobalConfiguration"},"title":"RoutingStrategyGlobalConfiguration","description":"RoutingStrategyGlobalConfiguration"},"RoutingStrategyRerouteTimeTriggeredConfig":{"additionalProperties":false,"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"type":"object","title":"RoutingStrategyRerouteTimeTriggeredConfig","description":"RoutingStrategyRerouteTimeTriggeredConfig"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"},"TimeTriggeredConfigurationContext":{"additionalProperties":false,"properties":{"priority":{"minimum":0,"type":"number"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"type":{"$ref":"#/components/schemas/TimeTriggeredConfigContextType"},"values":{"description":"The id of the context values. For example, if the type is FACILITY, then the values are the ids of the facilities.","items":{"format":"uuid","type":"string"},"maxItems":500,"type":"array"}},"required":["priority","type","values","timeTriggered"],"type":"object","title":"TimeTriggeredConfigurationContext","description":"TimeTriggeredConfigurationContext"},"TimeTriggeredConfigContextType":{"enum":["FACILITY","FACILITY_GROUP"],"type":"string","title":"TimeTriggeredConfigContextType","description":"TimeTriggeredConfigContextType"}}}}
```

## The RoutingStrategyNode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNode":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyCondition"}},"required":["active","config","id","nameLocalized"],"type":"object","title":"RoutingStrategyNode","description":"RoutingStrategyNode"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyCondition":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyCondition"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNode"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","id","nameLocalized"],"title":"RoutingStrategyCondition","description":"RoutingStrategyCondition"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyNodeConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"}}}}
```

## The RoutingStrategyNodeConfigCategory object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeConfigCategory":{"allOf":[{"$ref":"#/components/schemas/RoutingStrategyNodeConfigCategoryForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"}},"required":["id"],"title":"RoutingStrategyNodeConfigCategory","description":"RoutingStrategyNodeConfigCategory"},"RoutingStrategyNodeConfigCategoryForCreation":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"color":{"type":"string"}},"required":["nameLocalized","color"],"type":"object","title":"RoutingStrategyNodeConfigCategoryForCreation","description":"RoutingStrategyNodeConfigCategoryForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The RoutingStrategyNodeConfigCategoryForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeConfigCategoryForCreation":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"color":{"type":"string"}},"required":["nameLocalized","color"],"type":"object","title":"RoutingStrategyNodeConfigCategoryForCreation","description":"RoutingStrategyNodeConfigCategoryForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RoutingStrategyNodeConfigCategoryForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeConfigCategoryForModification":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"color":{"type":"string"},"version":{"type":"number"}},"required":["nameLocalized","color","version"],"type":"object","title":"RoutingStrategyNodeConfigCategoryForModification","description":"RoutingStrategyNodeConfigCategoryForModification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The RoutingStrategyNodeConfigCategoryForResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeConfigCategoryForResponse":{"allOf":[{"$ref":"#/components/schemas/RoutingStrategyNodeConfigCategory"}],"properties":{"name":{"type":"string"}},"title":"RoutingStrategyNodeConfigCategoryForResponse","description":"RoutingStrategyNodeConfigCategoryForResponse"},"RoutingStrategyNodeConfigCategory":{"allOf":[{"$ref":"#/components/schemas/RoutingStrategyNodeConfigCategoryForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"}},"required":["id"],"title":"RoutingStrategyNodeConfigCategory","description":"RoutingStrategyNodeConfigCategory"},"RoutingStrategyNodeConfigCategoryForCreation":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"color":{"type":"string"}},"required":["nameLocalized","color"],"type":"object","title":"RoutingStrategyNodeConfigCategoryForCreation","description":"RoutingStrategyNodeConfigCategoryForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The RoutingStrategyNodeConfigCategoryTransporter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeConfigCategoryTransporter":{"properties":{"routingStrategyNodeConfigCategories":{"items":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigCategoryForResponse"},"type":"array"},"total":{"description":"Total number of entities found for this query","type":"integer"}},"required":["routingStrategyNodeConfigCategories","total"],"type":"object","xml":{"name":"RoutingStrategyNodeConfigCategoryTransporter"},"title":"RoutingStrategyNodeConfigCategoryTransporter","description":"RoutingStrategyNodeConfigCategoryTransporter"},"RoutingStrategyNodeConfigCategoryForResponse":{"allOf":[{"$ref":"#/components/schemas/RoutingStrategyNodeConfigCategory"}],"properties":{"name":{"type":"string"}},"title":"RoutingStrategyNodeConfigCategoryForResponse","description":"RoutingStrategyNodeConfigCategoryForResponse"},"RoutingStrategyNodeConfigCategory":{"allOf":[{"$ref":"#/components/schemas/RoutingStrategyNodeConfigCategoryForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"}},"required":["id"],"title":"RoutingStrategyNodeConfigCategory","description":"RoutingStrategyNodeConfigCategory"},"RoutingStrategyNodeConfigCategoryForCreation":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"color":{"type":"string"}},"required":["nameLocalized","color"],"type":"object","title":"RoutingStrategyNodeConfigCategoryForCreation","description":"RoutingStrategyNodeConfigCategoryForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The RoutingStrategyNodeConfigForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"}}}}
```

## The RoutingStrategyNodeForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeForCreation":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigForUpsert"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForCreation"}},"required":["active","config","nameLocalized"],"type":"object","title":"RoutingStrategyNodeForCreation","description":"RoutingStrategyNodeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyConditionForCreation":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForCreation"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNodeForCreation"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","nameLocalized"],"title":"RoutingStrategyConditionForCreation","description":"RoutingStrategyConditionForCreation"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyNodeForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeForModification":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigForUpsert"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForModification"}},"required":["active","config","nameLocalized"],"type":"object","title":"RoutingStrategyNodeForModification","description":"RoutingStrategyNodeForModification"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyConditionForModification":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyConditionForModification"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNodeForModification"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","nameLocalized"],"title":"RoutingStrategyConditionForModification","description":"RoutingStrategyConditionForModification"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The RoutingStrategyNodeForReplace object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyNodeForReplace":{"additionalProperties":false,"description":"Node data for replacing a node in a routing strategy.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigForUpsert"}},"required":["active","nameLocalized","config"],"title":"RoutingStrategyNodeForReplace"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"}}}}
```

## The RoutingStrategyOrderSplitConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"}}}}
```

## The RoutingStrategyPathElement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyPathElement":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"evaluationResult":{"$ref":"#/components/schemas/RoutingStrategyEvaluationResultType"},"ref":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyPathElementType"}},"required":["type","ref","evaluationResult","nameLocalized"],"type":"object","title":"RoutingStrategyPathElement","description":"RoutingStrategyPathElement"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"RoutingStrategyEvaluationResultType":{"enum":["NODE_INACTIVE","NODE_ACTIVE","CONDITION_INACTIVE","CONDITION_FALSE","CONDITION_TRUE"],"type":"string","title":"RoutingStrategyEvaluationResultType","description":"RoutingStrategyEvaluationResultType"},"RoutingStrategyPathElementType":{"enum":["CONDITION","NODE"],"type":"string","title":"RoutingStrategyPathElementType","description":"RoutingStrategyPathElementType"}}}}
```

## The RoutingStrategyPathElementType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyPathElementType":{"enum":["CONDITION","NODE"],"type":"string","title":"RoutingStrategyPathElementType","description":"RoutingStrategyPathElementType"}}}}
```

## The RoutingStrategyPriorityRatingForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"}}}}
```

## The RoutingStrategyRatingForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"}}}}
```

## The RoutingStrategyReplaceConditionActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyReplaceConditionActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to replace a condition of a routing strategy.","properties":{"condition":{"$ref":"#/components/schemas/RoutingStrategyConditionForReplace"},"conditionId":{"type":"string"},"name":{"enum":["REPLACE_CONDITION"],"type":"string"}},"required":["name","conditionId","condition","version"],"title":"RoutingStrategyReplaceConditionActionParameter"},"AbstractRoutingStrategyActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractRoutingStrategyActionsParameter","description":"AbstractRoutingStrategyActionsParameter"},"RoutingStrategyConditionForReplace":{"additionalProperties":false,"description":"Condition data for replacing a condition in a routing strategy.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["active","nameLocalized","rule"],"title":"RoutingStrategyConditionForReplace"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The RoutingStrategyReplaceGlobalConfigurationActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyReplaceGlobalConfigurationActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to replace the global configuration of a routing strategy.","properties":{"globalConfiguration":{"$ref":"#/components/schemas/RoutingStrategyGlobalConfiguration"},"name":{"enum":["REPLACE_GLOBAL_CONFIGURATION"],"type":"string"}},"required":["name","globalConfiguration","version"],"title":"RoutingStrategyReplaceGlobalConfigurationActionParameter"},"AbstractRoutingStrategyActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractRoutingStrategyActionsParameter","description":"AbstractRoutingStrategyActionsParameter"},"RoutingStrategyGlobalConfiguration":{"additionalProperties":false,"properties":{"blacklistAssignedFacilities":{"description":"If true, facilities that have already been assigned to the order in a previous routing attempt will not be considered in the next routing attempt.","type":"boolean"},"defaultPrice":{"default":10,"description":"The price applied when no specific price is defined in the order or listing","type":"number"},"restowAfterMinutes":{"description":"The amount of minutes after which a restow is executed. If not set, restows will not be executed.","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"The amount of time, specified in ISO 8601 duration format, after which a routing plan is considered not routable. Note: The duration must be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"timeTriggeredByContext":{"items":{"$ref":"#/components/schemas/TimeTriggeredConfigurationContext"},"maxItems":500,"type":"array"}},"required":["defaultPrice"],"type":"object","xml":{"name":"RoutingStrategyGlobalConfiguration"},"title":"RoutingStrategyGlobalConfiguration","description":"RoutingStrategyGlobalConfiguration"},"RoutingStrategyRerouteTimeTriggeredConfig":{"additionalProperties":false,"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"type":"object","title":"RoutingStrategyRerouteTimeTriggeredConfig","description":"RoutingStrategyRerouteTimeTriggeredConfig"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"},"TimeTriggeredConfigurationContext":{"additionalProperties":false,"properties":{"priority":{"minimum":0,"type":"number"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"type":{"$ref":"#/components/schemas/TimeTriggeredConfigContextType"},"values":{"description":"The id of the context values. For example, if the type is FACILITY, then the values are the ids of the facilities.","items":{"format":"uuid","type":"string"},"maxItems":500,"type":"array"}},"required":["priority","type","values","timeTriggered"],"type":"object","title":"TimeTriggeredConfigurationContext","description":"TimeTriggeredConfigurationContext"},"TimeTriggeredConfigContextType":{"enum":["FACILITY","FACILITY_GROUP"],"type":"string","title":"TimeTriggeredConfigContextType","description":"TimeTriggeredConfigContextType"}}}}
```

## The RoutingStrategyReplaceNodeActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyReplaceNodeActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractRoutingStrategyActionsParameter"}],"description":"Action to replace a node of a routing strategy.","properties":{"name":{"enum":["REPLACE_NODE"],"type":"string"},"node":{"$ref":"#/components/schemas/RoutingStrategyNodeForReplace"},"nodeId":{"type":"string"}},"required":["name","nodeId","node","version"],"title":"RoutingStrategyReplaceNodeActionParameter"},"AbstractRoutingStrategyActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractRoutingStrategyActionsParameter","description":"AbstractRoutingStrategyActionsParameter"},"RoutingStrategyNodeForReplace":{"additionalProperties":false,"description":"Node data for replacing a node in a routing strategy.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfigForUpsert"}},"required":["active","nameLocalized","config"],"title":"RoutingStrategyNodeForReplace"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfigForUpsert":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFenceForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFenceForUpsert","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"maxItems":100,"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyPriorityRatingForUpsert","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"maxItems":100,"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyRatingForUpsert"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyRatingForUpsert","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"maxItems":100,"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfigForUpsert","description":"RoutingStrategyNodeConfigForUpsert"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyPriorityRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["type","active","implementation","priority"],"title":"RoutingStrategyPriorityRatingForUpsert","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyRatingForUpsert":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["type","active","implementation","maxPenalty"],"title":"RoutingStrategyRatingForUpsert","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"}}}}
```

## The RoutingStrategyRerouteConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"}}}}
```

## The RoutingStrategyRerouteTimeTriggeredConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyRerouteTimeTriggeredConfig":{"additionalProperties":false,"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"type":"object","title":"RoutingStrategyRerouteTimeTriggeredConfig","description":"RoutingStrategyRerouteTimeTriggeredConfig"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"}}}}
```

## The RoutingStrategyRerouteType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"}}}}
```

## The RoutingStrategyStandardFence object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"}}}}
```

## The RoutingStrategyStandardFenceForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyStandardFenceForUpsert":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"}}}}
```

## The RoutingStrategyStandardFenceType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"}}}}
```

## The RoutingStrategyStandardPriorityRating object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"}}}}
```

## The RoutingStrategyStandardPriorityRatingType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"}}}}
```

## The RoutingStrategyStandardRating object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"}}}}
```

## The RoutingStrategyStandardRatingType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"}}}}
```

## The RoutingStrategyToolkitFence object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"}}}}
```

## The RoutingStrategyToolkitFenceType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"}}}}
```

## The RoutingStrategyToolkitPriorityRating object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"}}}}
```

## The RoutingStrategyToolkitPriorityRatingType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"}}}}
```

## The RoutingStrategyToolkitRating object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"}}}}
```

## The RoutingStrategyToolkitRatingType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"}}}}
```

## The RoutingStrategyTransporter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"RoutingStrategyTransporter":{"properties":{"routingStrategies":{"items":{"$ref":"#/components/schemas/RoutingStrategy"},"type":"array"},"total":{"description":"Total number of entities found for this query","type":"integer"}},"required":["routingStrategies","total"],"type":"object","xml":{"name":"RoutingStrategyTransporter"},"title":"RoutingStrategyTransporter","description":"RoutingStrategyTransporter"},"RoutingStrategy":{"additionalProperties":true,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"globalConfiguration":{"$ref":"#/components/schemas/RoutingStrategyGlobalConfiguration"},"id":{"type":"string"},"inUse":{"description":"Only one strategy can be inUse","type":"boolean"},"name":{"type":"string"},"revision":{"description":"The revision of the routing strategy","type":"integer"},"rootNode":{"$ref":"#/components/schemas/RoutingStrategyNode"}},"required":["inUse","revision","id","nameLocalized","rootNode","globalConfiguration"]}],"type":"object","title":"RoutingStrategy","description":"RoutingStrategy"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"RoutingStrategyGlobalConfiguration":{"additionalProperties":false,"properties":{"blacklistAssignedFacilities":{"description":"If true, facilities that have already been assigned to the order in a previous routing attempt will not be considered in the next routing attempt.","type":"boolean"},"defaultPrice":{"default":10,"description":"The price applied when no specific price is defined in the order or listing","type":"number"},"restowAfterMinutes":{"description":"The amount of minutes after which a restow is executed. If not set, restows will not be executed.","type":"number"},"stopRoutingAttemptsAfterTime":{"default":"PT8H","description":"The amount of time, specified in ISO 8601 duration format, after which a routing plan is considered not routable. Note: The duration must be a multiple of 60 seconds.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"timeTriggeredByContext":{"items":{"$ref":"#/components/schemas/TimeTriggeredConfigurationContext"},"maxItems":500,"type":"array"}},"required":["defaultPrice"],"type":"object","xml":{"name":"RoutingStrategyGlobalConfiguration"},"title":"RoutingStrategyGlobalConfiguration","description":"RoutingStrategyGlobalConfiguration"},"RoutingStrategyRerouteTimeTriggeredConfig":{"additionalProperties":false,"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"type":"object","title":"RoutingStrategyRerouteTimeTriggeredConfig","description":"RoutingStrategyRerouteTimeTriggeredConfig"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"},"TimeTriggeredConfigurationContext":{"additionalProperties":false,"properties":{"priority":{"minimum":0,"type":"number"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"type":{"$ref":"#/components/schemas/TimeTriggeredConfigContextType"},"values":{"description":"The id of the context values. For example, if the type is FACILITY, then the values are the ids of the facilities.","items":{"format":"uuid","type":"string"},"maxItems":500,"type":"array"}},"required":["priority","type","values","timeTriggered"],"type":"object","title":"TimeTriggeredConfigurationContext","description":"TimeTriggeredConfigurationContext"},"TimeTriggeredConfigContextType":{"enum":["FACILITY","FACILITY_GROUP"],"type":"string","title":"TimeTriggeredConfigContextType","description":"TimeTriggeredConfigContextType"},"RoutingStrategyNode":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"categoryRef":{"type":"string"},"config":{"$ref":"#/components/schemas/RoutingStrategyNodeConfig"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyCondition"}},"required":["active","config","id","nameLocalized"],"type":"object","title":"RoutingStrategyNode","description":"RoutingStrategyNode"},"ActivationTimeFrame":{"additionalProperties":false,"properties":{"activeFrom":{"description":"Sets a date before which the associated entity does not become active","format":"date-time","type":"string"},"activeUntil":{"description":"Sets a date after which the associated entity becomes active","format":"date-time","type":"string"},"recurrence":{"$ref":"#/components/schemas/ActivationTimeFrameRecurrenceType"}},"required":["recurrence"],"type":"object","title":"ActivationTimeFrame","description":"ActivationTimeFrame"},"ActivationTimeFrameRecurrenceType":{"enum":["YEARLY","NONRECURRING"],"type":"string","title":"ActivationTimeFrameRecurrenceType","description":"ActivationTimeFrameRecurrenceType"},"RoutingStrategyNodeConfig":{"additionalProperties":false,"properties":{"fallbackFacility":{"$ref":"#/components/schemas/RoutingStrategyFallbackFacilityConfig"},"fences":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardFence"},{"$ref":"#/components/schemas/RoutingStrategyToolkitFence"}],"discriminator":{"propertyName":"type","mapping":{"StandardFence":"#/components/schemas/RoutingStrategyStandardFence","ToolkitFence":"#/components/schemas/RoutingStrategyToolkitFence"}}},"type":"array"},"orderSplit":{"$ref":"#/components/schemas/RoutingStrategyOrderSplitConfig"},"priorityRatings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardPriorityRating":"#/components/schemas/RoutingStrategyStandardPriorityRating","ToolkitPriorityRating":"#/components/schemas/RoutingStrategyToolkitPriorityRating"}}},"type":"array","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"ratings":{"items":{"anyOf":[{"$ref":"#/components/schemas/RoutingStrategyStandardRating"},{"$ref":"#/components/schemas/RoutingStrategyToolkitRating"}],"discriminator":{"propertyName":"type","mapping":{"StandardRating":"#/components/schemas/RoutingStrategyStandardRating","ToolkitRating":"#/components/schemas/RoutingStrategyToolkitRating"}}},"type":"array"},"reroute":{"$ref":"#/components/schemas/RoutingStrategyRerouteConfig"}},"required":["fences","ratings"],"type":"object","title":"RoutingStrategyNodeConfig","description":"RoutingStrategyNodeConfig"},"RoutingStrategyFallbackFacilityConfig":{"properties":{"active":{"default":false,"type":"boolean"},"facilityRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"fallbackAfterTime":{"default":"PT0H","description":"Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.","pattern":"^P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["facilityRefs","active","fallbackAfterTime"],"title":"RoutingStrategyFallbackFacilityConfig","description":"RoutingStrategyFallbackFacilityConfig"},"RoutingStrategyStandardFence":{"additionalProperties":false,"description":"Routing Strategy Fence.","properties":{"active":{"type":"boolean"},"activeMode":{"$ref":"#/components/schemas/FenceMode"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/FenceImplementation"},"name":{"type":"string"},"supportedModes":{"items":{"$ref":"#/components/schemas/FenceMode"},"type":"array"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardFenceType"}},"required":["active","implementation","type"],"title":"RoutingStrategyFence","type":"object"},"FenceMode":{"enum":["static","reactive"],"type":"string","title":"FenceMode","description":"FenceMode"},"FenceImplementation":{"description":"<i>This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and/or might not be available at all times in your API instance. It could also disappear without warning. It currently does not fall under our SLA regulations. For details, see our <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\">API lifecycle documentation</a></i>","enum":["FACILITY-BUSINESSTYPE","STOCK-AVAILABILITY","FACILITY-CARRIERAVAILABILITY","FACILITY-COUNTRY","FACILITY-PICKING-TIME-CAPACITY","PRESELECTED-FACILITY","SAMEDAY-POSSIBLE","AVOID-ZERO-STOCK","PACKAGING-POSSIBLE"],"type":"string","xml":{"name":"FenceImplementation"},"title":"FenceImplementation"},"RoutingStrategyStandardFenceType":{"enum":["StandardFence"],"type":"string","title":"RoutingStrategyStandardFenceType","description":"RoutingStrategyStandardFenceType"},"RoutingStrategyToolkitFence":{"additionalProperties":false,"description":"Routing Strategy Toolkit Fence.","properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitFenceType"}},"required":["nameLocalized","active","order","type","referenceId"],"title":"RoutingStrategyToolkitFence"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"RoutingStrategyToolkitFenceType":{"enum":["ToolkitFence"],"type":"string","title":"RoutingStrategyToolkitFenceType","description":"RoutingStrategyToolkitFenceType"},"RoutingStrategyOrderSplitConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"activeForSameday":{"type":"boolean"},"maxSplitCount":{"type":"integer"},"shouldUseWaitingRoomForPreBackOrderItems":{"type":"boolean"}},"required":["active","maxSplitCount","activeForSameday","shouldUseWaitingRoomForPreBackOrderItems"],"type":"object","title":"RoutingStrategyOrderSplitConfig","description":"RoutingStrategyOrderSplitConfig"},"RoutingStrategyStandardPriorityRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders, ordered by priority.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"name":{"type":"string"},"priority":{"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardPriorityRatingType"}},"required":["active","priority","type","implementation"],"title":"RoutingStrategyStandardPriorityRating","type":"object"},"AbstractRatingConfiguration":{"description":"Base configuration for ratings. See documentation for details.","properties":{"type":{"$ref":"#/components/schemas/RatingConfigurationType"}},"title":"AbstractRatingConfiguration","type":"object","xml":{"name":"AbstractRatingConfiguration"}},"RatingConfigurationType":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Identifies the rating configuration variant and determines which properties are applicable.","enum":["COST_COMPONENTS"],"type":"string","xml":{"name":"RatingConfigurationType"},"title":"RatingConfigurationType"},"RatingImplementation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Discriminator identifying a rating variant.","enum":["STOCK-BALANCING","GEO-DISTANCE","TURNOVER","STOCK-AVAILABILITY","WORKLOAD-BALANCING","MATCHING-BUSINESSTYPE","PREFER-STORE","PREFER-WAREHOUSE","ZONE","EXPIRY-DATE","CAPACITY","DELIVERY-COSTS","DELIVERY-TIME","COST-COMPONENTS","NUMBER-OF-DELIVERIES"],"type":"string","xml":{"name":"RatingImplementation"},"title":"RatingImplementation"},"RoutingStrategyStandardPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating, ordered by priority.","enum":["StandardPriorityRating"],"type":"string","title":"RoutingStrategyStandardPriorityRatingType"},"RoutingStrategyToolkitPriorityRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating, ordered by priority.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the rating","type":"string"},"priority":{"description":"The priority of this rating","type":"integer"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitPriorityRatingType"}},"required":["active","priority","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitPriorityRating","type":"object"},"RoutingStrategyToolkitPriorityRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating, ordered by priority.","enum":["ToolkitPriorityRating"],"type":"string","title":"RoutingStrategyToolkitPriorityRatingType"},"RoutingStrategyStandardRating":{"additionalProperties":false,"description":"A rating is used to rate a set of possible facilities against each other during routing of orders.","properties":{"active":{"type":"boolean"},"configuration":{"$ref":"#/components/schemas/AbstractRatingConfiguration"},"description":{"type":"string"},"implementation":{"$ref":"#/components/schemas/RatingImplementation"},"maxPenalty":{"minimum":0,"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RoutingStrategyStandardRatingType"}},"required":["active","maxPenalty","type","implementation"],"title":"RoutingStrategyStandardRating","type":"object"},"RoutingStrategyStandardRatingType":{"description":"Discriminator identifying a rating as a routing strategy standard rating.","enum":["StandardRating"],"type":"string","title":"RoutingStrategyStandardRatingType"},"RoutingStrategyToolkitRating":{"additionalProperties":false,"description":"Routing Strategy Toolkit Rating.","properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this rating is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"allOf":[{"$ref":"#/components/schemas/ToolkitAllowedEntities"}],"deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"referenceId":{"type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"},"type":{"$ref":"#/components/schemas/RoutingStrategyToolkitRatingType"}},"required":["active","maxPenalty","referenceId","nameLocalized","type"],"title":"RoutingStrategyToolkitRating","type":"object"},"RoutingStrategyToolkitRatingType":{"description":"Discriminator identifying a rating as a routing strategy toolkit rating.","enum":["ToolkitRating"],"type":"string","title":"RoutingStrategyToolkitRatingType"},"RoutingStrategyRerouteConfig":{"additionalProperties":false,"properties":{"clickAndCollect":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"},"manualReroute":{"type":"boolean"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"shipFromStore":{"$ref":"#/components/schemas/RoutingStrategyFacilityRerouteConfig"}},"type":"object","title":"RoutingStrategyRerouteConfig","description":"RoutingStrategyRerouteConfig"},"RoutingStrategyFacilityRerouteConfig":{"additionalProperties":false,"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RoutingStrategyRerouteType"}},"required":["rerouteType"],"type":"object","title":"RoutingStrategyFacilityRerouteConfig","description":"RoutingStrategyFacilityRerouteConfig"},"RoutingStrategyRerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RoutingStrategyRerouteType"},"RoutingStrategyCondition":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"activationTimeFrames":{"items":{"$ref":"#/components/schemas/ActivationTimeFrame"},"maxItems":1,"type":"array"},"active":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"nextCondition":{"$ref":"#/components/schemas/RoutingStrategyCondition"},"nextNode":{"$ref":"#/components/schemas/RoutingStrategyNode"},"rule":{"$ref":"#/components/schemas/RoutingStrategyConditionRule"}},"required":["nextNode","active","rule","id","nameLocalized"],"title":"RoutingStrategyCondition","description":"RoutingStrategyCondition"},"RoutingStrategyConditionRule":{"additionalProperties":false,"properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/RoutingStrategyConditionPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"RoutingStrategyConditionRule"},"title":"RoutingStrategyConditionRule","description":"RoutingStrategyConditionRule"},"RoutingStrategyConditionPredicate":{"description":"The predicate for a routing strategy condition rule","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator"],"type":"object","xml":{"name":"RoutingStrategyConditionPredicate"},"title":"RoutingStrategyConditionPredicate"}}}}
```

## The SafetyStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SafetyStock":{"properties":{"created":{"format":"date-time","type":"string"},"facilityRef":{"type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"},"version":{"type":"number"}},"required":["tenantArticleId","value","created","id","lastModified","version"],"title":"SafetyStock","type":"object","description":"SafetyStock"}}}}
```

## The SafetyStockBulkOperation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SafetyStockBulkOperation":{"properties":{"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"}},"required":["tenantArticleId","value"],"title":"SafetyStockBulkOperation","type":"object","description":"SafetyStockBulkOperation"}}}}
```

## The SafetyStockBulkOperationResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SafetyStockBulkOperationResult":{"properties":{"error":{"$ref":"#/components/schemas/BulkOperationError"},"facilityRef":{"type":"string"},"status":{"enum":["UPDATED","CREATED","FAILED"],"type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"}},"required":["tenantArticleId","facilityRef","value","status"],"title":"SafetyStockBulkOperationResult","type":"object","description":"SafetyStockBulkOperationResult"},"BulkOperationError":{"properties":{"message":{"type":"string"},"type":{"enum":["NOT_FOUND","NOT_ALLOWED","VALIDATION","UNKNOWN"],"type":"string"}},"required":["type","message"],"title":"BulkOperationError","type":"object","description":"BulkOperationError"}}}}
```

## The SafetyStockBulkOperations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SafetyStockBulkOperations":{"properties":{"operations":{"items":{"$ref":"#/components/schemas/SafetyStockBulkOperation"},"maxItems":500,"minItems":1,"type":"array"}},"required":["operations"],"title":"SafetyStockBulkOperations","type":"object","description":"SafetyStockBulkOperations"},"SafetyStockBulkOperation":{"properties":{"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"}},"required":["tenantArticleId","value"],"title":"SafetyStockBulkOperation","type":"object","description":"SafetyStockBulkOperation"}}}}
```

## The SafetyStocksPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SafetyStocksPaginatedResult":{"properties":{"safetyStocks":{"items":{"$ref":"#/components/schemas/SafetyStock"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","safetyStocks"],"title":"SafetyStocksPaginatedResult","type":"object","description":"SafetyStocksPaginatedResult"},"SafetyStock":{"properties":{"created":{"format":"date-time","type":"string"},"facilityRef":{"type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"},"version":{"type":"number"}},"required":["tenantArticleId","value","created","id","lastModified","version"],"title":"SafetyStock","type":"object","description":"SafetyStock"}}}}
```

## The ScannableIdentifier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScannableIdentifier":{"properties":{"identifiers":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"searchType":{"enum":["PREFIX","SUFFIX","CONTAINS"],"type":"string"}},"required":["identifiers"],"title":"ScannableIdentifier","type":"object","description":"ScannableIdentifier"}}}}
```

## The ScanningRuleConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"}}}}
```

## The ScanningRuleTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"}}}}
```

## The ScanningRuleValue object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"}}}}
```

## The ScheduledPickJobReleaseConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScheduledPickJobReleaseConfiguration":{"properties":{"openPickJobLeadTimeInMinutes":{"description":"This config describes when a scheduled PickJob should be released and made available for picking (pickjob.pickingTimes.latest - openPickJobLeadTimeInMinutes = time when the PickJob should be released).","type":"integer"}},"required":["openPickJobLeadTimeInMinutes"],"type":"object","title":"ScheduledPickJobReleaseConfiguration","description":"ScheduledPickJobReleaseConfiguration"}}}}
```

## The ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"}},"title":"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter","type":"object","description":"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter"}}}}
```

## The ScopedAvailabilityConfigPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScopedAvailabilityConfigPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"scopedAvailabilityConfigs":{"items":{"$ref":"#/components/schemas/InventoryArticleAvailabilityChangedEventScope"},"type":"array"},"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","scopedAvailabilityConfigs"],"title":"ScopedAvailabilityConfigPaginatedResult","type":"object","description":"ScopedAvailabilityConfigPaginatedResult"},"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"},"InventoryArticleAvailabilityChangedEventScope":{"properties":{"created":{"format":"date-time","type":"string"},"facilityGroupRefs":{"items":{"type":"string"},"type":"array"},"facilityRefs":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"key":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"type":"number"}},"required":["id","key","status","version","created","lastModified"],"title":"InventoryArticleAvailabilityChangedEventScope","type":"object","description":"InventoryArticleAvailabilityChangedEventScope"}}}}
```

## The ScopedAvailabilityConfigSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScopedAvailabilityConfigSearchPayload":{"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/ScopedAvailabilityConfigSearchQuery"},"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/ScopedAvailabilityConfigSort"},"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":"ScopedAvailabilityConfigSearchPayload","type":"object","description":"ScopedAvailabilityConfigSearchPayload"},"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"},"ScopedAvailabilityConfigSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ScopedAvailabilityConfigSearchQuery"},"maxItems":500,"type":"array"},"facilityGroupRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityGroupRefs"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"key":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by key"},"or":{"items":{"$ref":"#/components/schemas/ScopedAvailabilityConfigSearchQuery"},"maxItems":500,"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter"}],"description":"Search by status"}},"title":"ScopedAvailabilityConfigSearchQuery","type":"object","description":"ScopedAvailabilityConfigSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"}},"title":"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter","type":"object","description":"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter"},"ScopedAvailabilityConfigSort":{"properties":{"id":{"enum":["ASC","DESC"],"type":"string"},"key":{"enum":["ASC","DESC"],"type":"string"}},"title":"ScopedAvailabilityConfigSort","type":"object","description":"ScopedAvailabilityConfigSort"}}}}
```

## The ScopedAvailabilityConfigSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScopedAvailabilityConfigSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ScopedAvailabilityConfigSearchQuery"},"maxItems":500,"type":"array"},"facilityGroupRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityGroupRefs"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"key":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by key"},"or":{"items":{"$ref":"#/components/schemas/ScopedAvailabilityConfigSearchQuery"},"maxItems":500,"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter"}],"description":"Search by status"}},"title":"ScopedAvailabilityConfigSearchQuery","type":"object","description":"ScopedAvailabilityConfigSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"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"},"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"}},"title":"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter","type":"object","description":"ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter"}}}}
```

## The ScopedAvailabilityConfigSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScopedAvailabilityConfigSort":{"properties":{"id":{"enum":["ASC","DESC"],"type":"string"},"key":{"enum":["ASC","DESC"],"type":"string"}},"title":"ScopedAvailabilityConfigSort","type":"object","description":"ScopedAvailabilityConfigSort"}}}}
```

## The ScopedCapability object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScopedCapability":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"configurations":{"items":{"anyOf":[{"$ref":"#/components/schemas/CarrierConfiguration"},{"$ref":"#/components/schemas/SubstitutionConfiguration"},{"$ref":"#/components/schemas/RerouteShortPickConfiguration"},{"$ref":"#/components/schemas/ReturnNoteConfiguration"}]},"type":"array"},"currentUserPermissions":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/CapabilityStatus"}},"required":["name","status"],"type":"object","title":"ScopedCapability","description":"ScopedCapability"},"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"},"CarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"CarrierConfiguration","type":"object","description":"CarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"},"SubstitutionConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"description":"Substitution Configuration","properties":{"active":{"default":true,"description":"Toggle for substitution articles.","type":"boolean"}},"required":["active"],"title":"SubstitutionConfiguration","type":"object"},"RerouteShortPickConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"description":"Reroute ShortPick Configuration","properties":{"blacklistAssignedFacilities":{"default":false,"description":"Does not consider facilities which previously owned the pickjob during routing.","type":"boolean"},"clickAndCollectReroute":{"$ref":"#/components/schemas/ClickAndCollectRerouteConfiguration"},"id":{"type":"string"},"rerouteZeroPicksOnly":{"default":false,"description":"Specifies whether only pick jobs with zero items picked are eligible for rerouting.","type":"boolean"},"restowAfterMinutes":{"description":"The amount of minutes after which an automated restow is executed","type":"number"},"shipFromStoreReroute":{"$ref":"#/components/schemas/ShipFromStoreRerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreReroute"],"title":"RerouteShortPickConfiguration","type":"object"},"ClickAndCollectRerouteConfiguration":{"properties":{"active":{"type":"boolean"},"rerouteType":{"$ref":"#/components/schemas/RerouteType"}},"required":["active"],"type":"object","title":"ClickAndCollectRerouteConfiguration","description":"ClickAndCollectRerouteConfiguration"},"RerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The short picked line items will be moved to a new routing plan and rerouted","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RerouteType"},"ShipFromStoreRerouteConfiguration":{"properties":{"active":{"type":"boolean"},"allowManualReroute":{"default":false,"deprecated":true,"description":"@deprecated This config property is deprecated since 26/02/24. Use GlobalManualRerouteConfiguration instead.","type":"boolean"},"facilityWideRerouteOnShortPick":{"default":false,"type":"boolean"},"rerouteTargetTime":{"description":"Only pickJobs where the targetTime in not larger than now plus this number are rerouted","type":"number"},"rerouteType":{"$ref":"#/components/schemas/RerouteType"}},"required":["active","rerouteType"],"type":"object","title":"ShipFromStoreRerouteConfiguration","description":"ShipFromStoreRerouteConfiguration"},"ReturnNoteConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"description":"Return Note Configuration","properties":{"articleIdLabel":{"$ref":"#/components/schemas/LocaleString"},"articleTitleLabel":{"$ref":"#/components/schemas/LocaleString"},"companyAddress":{"$ref":"#/components/schemas/CompanyAddress"},"disclaimer":{"$ref":"#/components/schemas/LocaleString"},"disclaimerHeadline":{"$ref":"#/components/schemas/LocaleString"},"displayPageLabel":{"default":false,"description":"Determines if the page label should be shown","type":"boolean"},"headline":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"logoUrl":{"type":"string"},"orderDateLabel":{"$ref":"#/components/schemas/LocaleString"},"orderNumberLabel":{"$ref":"#/components/schemas/LocaleString"},"pageLabel":{"$ref":"#/components/schemas/LocaleString"},"pdfBackgroundConfiguration":{"$ref":"#/components/schemas/PdfBackgroundConfiguration"},"quantityLabel":{"$ref":"#/components/schemas/LocaleString"},"reasons":{"deprecated":true,"description":"Deprecated - use ReturnConfiguration.availableReturnReasons instead","items":{"$ref":"#/components/schemas/LocaleString"},"type":"array"},"returnReasonExplanation":{"$ref":"#/components/schemas/LocaleString"},"returnReasonExplanationHeadline":{"$ref":"#/components/schemas/LocaleString"},"returnReasonLabel":{"$ref":"#/components/schemas/LocaleString"},"substituteText":{"$ref":"#/components/schemas/LocaleString"}},"required":["id","orderDateLabel","orderNumberLabel","headline","quantityLabel","articleIdLabel","articleTitleLabel","returnReasonLabel","disclaimerHeadline","disclaimer","pageLabel"],"title":"ReturnNoteConfiguration","type":"object"},"CompanyAddress":{"properties":{"city":{"pattern":"^.+$","type":"string"},"country":{"pattern":"^.+$","type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"name":{"pattern":"^.+$","type":"string"},"postalCode":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["name","street","postalCode","city","country"],"type":"object","title":"CompanyAddress","description":"CompanyAddress"},"PdfBackgroundConfiguration":{"properties":{"firstPageBackgroundFileUrl":{"description":"File url of the background image that will be used for the first page","type":"string"},"followingPageBackgroundFileUrl":{"description":"File url of background image that will be used for 2-n pages","type":"string"}},"type":"object","title":"PdfBackgroundConfiguration","description":"PdfBackgroundConfiguration"},"CapabilityStatus":{"enum":["enabled","inactive","disabled"],"type":"string","title":"CapabilityStatus","description":"CapabilityStatus"}}}}
```

## The Score object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"}}}}
```

## The ScoreName object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"}}}}
```

## The ScoreType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"}}}}
```

## The SearchFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SearchFilter":{"properties":{"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"}},"title":"SearchFilter","type":"object","description":"SearchFilter"}}}}
```

## The SearchOptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The SearchTrackingStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SearchTrackingStatus":{"description":"The state of the KEP, the same as TrackingStatus enum but in uppercase, it is used for Search Filters","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"title":"SearchTrackingStatus","type":"string"}}}}
```

## The Section object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"}}}}
```

## The ServiceContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"description":{"description":"Translated description, filled on request based on descriptionLocalized.","minLength":1,"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"facilityRef":{"description":"Id of the facility this container is used in.","minLength":1,"type":"string"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"id":{"description":"The id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItem"},"maxItems":50,"type":"array"},"name":{"description":"Translated name, filled on request based on nameLocalized.","minLength":1,"type":"string"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"operativeProcessRef":{"description":"Reference to related operative process","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"status":{"default":"AVAILABLE","description":"The status of the service container. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a service container is created, it is automatically set to AVAILABLE. When a service container is deleted, it is automatically set to OBSOLETE.","enum":["AVAILABLE","OBSOLETE"],"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"type":{"description":"Type of this service container","enum":["VIRTUAL","PHYSICAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems","nameLocalized","created","lastModified","version","id","facilityRef","type","status"],"title":"ServiceContainer","type":"object","description":"ServiceContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ServiceContainerLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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":"Cross-entity identifier linking this line item back to the originating pick line item.","minLength":1,"type":"string"},"id":{"description":"id line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the items, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","globalLineItemId","quantity","id"],"title":"ServiceContainerLineItem","type":"object","description":"ServiceContainerLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The ServiceContainerForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceContainerForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItemForCreation"},"maxItems":50,"type":"array"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems"],"title":"ServiceContainerForCreation","type":"object","description":"ServiceContainerForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ServiceContainerLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened.","minLength":1,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","quantity"],"title":"ServiceContainerLineItemForCreation","type":"object","description":"ServiceContainerLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The ServiceContainerLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceContainerLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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":"Cross-entity identifier linking this line item back to the originating pick line item.","minLength":1,"type":"string"},"id":{"description":"id line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the items, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","globalLineItemId","quantity","id"],"title":"ServiceContainerLineItem","type":"object","description":"ServiceContainerLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ServiceContainerLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceContainerLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened.","minLength":1,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","quantity"],"title":"ServiceContainerLineItemForCreation","type":"object","description":"ServiceContainerLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ServiceContainers object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceContainers":{"properties":{"serviceContainers":{"description":"List of service containers matching the query","items":{"$ref":"#/components/schemas/ServiceContainer"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"ServiceContainers","type":"object","description":"ServiceContainers"},"ServiceContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"description":{"description":"Translated description, filled on request based on descriptionLocalized.","minLength":1,"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"facilityRef":{"description":"Id of the facility this container is used in.","minLength":1,"type":"string"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"id":{"description":"The id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItem"},"maxItems":50,"type":"array"},"name":{"description":"Translated name, filled on request based on nameLocalized.","minLength":1,"type":"string"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"operativeProcessRef":{"description":"Reference to related operative process","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"status":{"default":"AVAILABLE","description":"The status of the service container. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a service container is created, it is automatically set to AVAILABLE. When a service container is deleted, it is automatically set to OBSOLETE.","enum":["AVAILABLE","OBSOLETE"],"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"type":{"description":"Type of this service container","enum":["VIRTUAL","PHYSICAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems","nameLocalized","created","lastModified","version","id","facilityRef","type","status"],"title":"ServiceContainer","type":"object","description":"ServiceContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ServiceContainerLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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":"Cross-entity identifier linking this line item back to the originating pick line item.","minLength":1,"type":"string"},"id":{"description":"id line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the items, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","globalLineItemId","quantity","id"],"title":"ServiceContainerLineItem","type":"object","description":"ServiceContainerLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The ServiceContainerWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceContainerWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ServiceContainer"}},"required":["payload"],"type":"object","title":"ServiceContainerWebHookEvent","description":"ServiceContainerWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ServiceContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"description":{"description":"Translated description, filled on request based on descriptionLocalized.","minLength":1,"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"facilityRef":{"description":"Id of the facility this container is used in.","minLength":1,"type":"string"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"id":{"description":"The id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItem"},"maxItems":50,"type":"array"},"name":{"description":"Translated name, filled on request based on nameLocalized.","minLength":1,"type":"string"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"operativeProcessRef":{"description":"Reference to related operative process","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"status":{"default":"AVAILABLE","description":"The status of the service container. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a service container is created, it is automatically set to AVAILABLE. When a service container is deleted, it is automatically set to OBSOLETE.","enum":["AVAILABLE","OBSOLETE"],"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"type":{"description":"Type of this service container","enum":["VIRTUAL","PHYSICAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems","nameLocalized","created","lastModified","version","id","facilityRef","type","status"],"title":"ServiceContainer","type":"object","description":"ServiceContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ServiceContainerLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"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":"Cross-entity identifier linking this line item back to the originating pick line item.","minLength":1,"type":"string"},"id":{"description":"id line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the items, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","globalLineItemId","quantity","id"],"title":"ServiceContainerLineItem","type":"object","description":"ServiceContainerLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The ServiceData object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceData":{"properties":{"availableLineItems":{"description":"Information about the items that are available for the service job.","items":{"$ref":"#/components/schemas/ServiceDataAvailableLineItem"},"maxItems":200,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"id":{"description":"ID of the Service Data","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"serviceJobRefs":{"description":"IDs of all serviceJobs connected to this service data","items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["serviceJobRefs","availableLineItems","created","lastModified","version","id"],"title":"ServiceData","type":"object","description":"ServiceData"},"ServiceDataAvailableLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information for this available line item"},"availableQuantity":{"description":"Quantity of the item that is available","minimum":0,"type":"integer"},"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"},"executedServiceJobData":{"description":"History of service jobs that have processed this available line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"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 available line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity","availableQuantity","executedServiceJobData"],"title":"ServiceDataAvailableLineItem","type":"object","description":"ServiceDataAvailableLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"},"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"}}}}
```

## The ServiceDataAvailableLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceDataAvailableLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information for this available line item"},"availableQuantity":{"description":"Quantity of the item that is available","minimum":0,"type":"integer"},"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"},"executedServiceJobData":{"description":"History of service jobs that have processed this available line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"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 available line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity","availableQuantity","executedServiceJobData"],"title":"ServiceDataAvailableLineItem","type":"object","description":"ServiceDataAvailableLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"},"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"}}}}
```

## The ServiceDataAvailableLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceDataAvailableLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information for this available line item"},"availableQuantity":{"description":"Quantity of the item that is available","minimum":0,"type":"integer"},"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"},"executedServiceJobData":{"description":"History of service jobs that have processed this available line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":0,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity","availableQuantity","executedServiceJobData"],"title":"ServiceDataAvailableLineItemForCreation","type":"object","description":"ServiceDataAvailableLineItemForCreation"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The ServiceDataAvailableLineItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceDataAvailableLineItemForUpdate":{"properties":{"availableQuantity":{"description":"Available quantity of the items","minimum":0,"type":"integer"},"executedServiceJobData":{"description":"Updated history of service jobs that have processed this line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"id":{"description":"ID of the available line item to update","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":0,"type":"integer"}},"required":["id"],"title":"ServiceDataAvailableLineItemForUpdate","type":"object","description":"ServiceDataAvailableLineItemForUpdate"},"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"}}}}
```

## The ServiceDataExecutedServiceJobs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"}}}}
```

## The ServiceDataItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The ServiceItemInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceItemInfo":{"properties":{"quantity":{"description":"Quantity of the item to be (un-)selected).","minimum":1,"type":"integer"},"serviceItemRef":{"description":"Id of the ServiceItem to be (un-)selected).","minLength":1,"type":"string"}},"required":["serviceItemRef","quantity"],"title":"ServiceItemInfo","type":"object","description":"ServiceItemInfo"}}}}
```

## The ServiceItemSelectQuantityActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceItemSelectQuantityActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'SELECT_ITEMS_FOR_SERVICE_JOB'","enum":["SELECT_ITEMS_FOR_SERVICE_JOB"],"type":"string"},"serviceItemsToSelect":{"description":"Service items that are selected to be used in the service job","items":{"$ref":"#/components/schemas/ServiceItemInfo"},"maxItems":50,"minItems":1,"type":"array"},"serviceJobVersion":{"description":"Version of the service job","minimum":0,"type":"integer"}},"required":["name","serviceItemsToSelect","serviceJobVersion"],"title":"ServiceItemSelectQuantityActionParameter","type":"object","description":"ServiceItemSelectQuantityActionParameter"},"ServiceItemInfo":{"properties":{"quantity":{"description":"Quantity of the item to be (un-)selected).","minimum":1,"type":"integer"},"serviceItemRef":{"description":"Id of the ServiceItem to be (un-)selected).","minLength":1,"type":"string"}},"required":["serviceItemRef","quantity"],"title":"ServiceItemInfo","type":"object","description":"ServiceItemInfo"}}}}
```

## The ServiceItemUnselectQuantityActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceItemUnselectQuantityActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'UNSELECT_ITEMS_FOR_SERVICE_JOB'","enum":["UNSELECT_ITEMS_FOR_SERVICE_JOB"],"type":"string"},"serviceItemsToUnselect":{"description":"Service items that are unselected from being used in the service job","items":{"$ref":"#/components/schemas/ServiceItemInfo"},"maxItems":50,"minItems":1,"type":"array"},"serviceJobVersion":{"description":"Version of the service job","minimum":0,"type":"integer"}},"required":["name","serviceItemsToUnselect","serviceJobVersion"],"title":"ServiceItemUnselectQuantityActionParameter","type":"object","description":"ServiceItemUnselectQuantityActionParameter"},"ServiceItemInfo":{"properties":{"quantity":{"description":"Quantity of the item to be (un-)selected).","minimum":1,"type":"integer"},"serviceItemRef":{"description":"Id of the ServiceItem to be (un-)selected).","minLength":1,"type":"string"}},"required":["serviceItemRef","quantity"],"title":"ServiceItemInfo","type":"object","description":"ServiceItemInfo"}}}}
```

## The ServiceJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJob":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformation"},"maxItems":15,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":10,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customServiceRef":{"description":"Id of the customService this ServiceJob was created from.","type":"string"},"description":{"description":"Translated description of this service job derived from descriptionLocalized","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"executionTimeInMin":{"description":"Time in minutes this service job is expected to take to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"id":{"description":"Unique ID of this service job","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images taken from the connected custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"inheritedLineItems":{"deprecated":true,"description":"deprecated: use availableLineItems on ServiceData instead","items":{"$ref":"#/components/schemas/InheritedServiceJobLineItem"},"maxItems":200,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing this service job","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items worked on in this service job are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItem"},"maxItems":50,"type":"array"},"linkedServiceJobsRef":{"description":"ID of the Linked Service Job, the Service Job should reference.","type":"string"},"name":{"description":"Translated name of this service job derived from nameLocalized","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the process this service job belongs to","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItem"},"maxItems":50,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"status":{"description":"Current status of this service job","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"statusInformation":{"allOf":[{"$ref":"#/components/schemas/ServiceJobStatusInformation"}],"description":"Additional information about the current status of this service job"},"subStatus":{"description":"Additional sub-status information about this service job","enum":["LINE_ITEMS_MISSING","REQUIRED_LINE_ITEMS_UNFULFILLABLE"],"type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["customServiceRef","processRef","facilityRef","lineItems","targetTime","created","lastModified","version","id","status","nameLocalized","itemsRequired"],"title":"ServiceJob","type":"object","description":"ServiceJob"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"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"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"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":"Unique ID of this inherited line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"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":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"},"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"}}}}
```

## The ServiceJobAdditionalInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ServiceJobAdditionalInformationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobAdditionalInformationForCreation":{"properties":{"additionalInformationRef":{"description":"ID of the additional information. Either tenantAdditionalInformationId or additionalInformationRef must be set.","minLength":1,"type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information. Either tenantAdditionalInformationId or additionalInformationRef must be set.","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForCreation","type":"object","description":"ServiceJobAdditionalInformationForCreation"}}}}
```

## The ServiceJobAdditionalInformationForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobAdditionalInformationForUpdate":{"properties":{"additionalInformationRef":{"description":"ID of the additional information","type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForUpdate","type":"object","description":"ServiceJobAdditionalInformationForUpdate"}}}}
```

## The ServiceJobAddTargetTimeActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobAddTargetTimeActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'ADD_TARGET_TIME'","enum":["ADD_TARGET_TIME"],"type":"string"},"targetTime":{"description":"TargetTime you want to set for given ServiceJob. If the ServiceJob already has a TargetTime, this Action will fail.","format":"date-time","type":"string"},"version":{"description":"Version of the service job","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"ServiceJobAddTargetTimeActionParameter","type":"object","description":"ServiceJobAddTargetTimeActionParameter"}}}}
```

## The ServiceJobAlteredLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"}}}}
```

## The ServiceJobCancelledActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobCancelledActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"cancelReason":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the action to perform, must be 'CancelServiceJob'","enum":["CancelServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobCancelledActionParameter","type":"object","description":"ServiceJobCancelledActionParameter"},"ServiceJobAdditionalInformationForUpdate":{"properties":{"additionalInformationRef":{"description":"ID of the additional information","type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForUpdate","type":"object","description":"ServiceJobAdditionalInformationForUpdate"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ServiceJobCancelReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobCancelReason":{"properties":{"cancelReasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"description":"Indicates if this cancel reason is currently active and can be selected","type":"boolean"},"cancelReason":{"description":"translated cancelReason selected from cancelReasonLocalized","minLength":1,"type":"string"}},"required":["active","cancelReasonLocalized"],"title":"ServiceJobCancelReason","type":"object","description":"ServiceJobCancelReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ServiceJobFinishedActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobFinishedActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"name":{"description":"Name of the action to perform, must be 'FinishServiceJob'","enum":["FinishServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobFinishedActionParameter","type":"object","description":"ServiceJobFinishedActionParameter"},"ServiceJobAdditionalInformationForUpdate":{"properties":{"additionalInformationRef":{"description":"ID of the additional information","type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForUpdate","type":"object","description":"ServiceJobAdditionalInformationForUpdate"}}}}
```

## The ServiceJobForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobForCreation":{"properties":{"additionalInformation":{"description":"Additional information to be collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForCreation"},"maxItems":15,"type":"array"},"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"maxItems":10,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customServiceRef":{"description":"ID of the Custom Service, the Service Job should reference. Either this and/or the tenantCustomServiceId must passed.","type":"string"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItemForCreation"},"maxItems":50,"type":"array"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the Process, the Service Job belongs to.","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItemForCreation"},"maxItems":50,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"}},"required":["facilityRef","targetTime"],"title":"ServiceJobForCreation","type":"object","description":"ServiceJobForCreation"},"ServiceJobAdditionalInformationForCreation":{"properties":{"additionalInformationRef":{"description":"ID of the additional information. Either tenantAdditionalInformationId or additionalInformationRef must be set.","minLength":1,"type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information. Either tenantAdditionalInformationId or additionalInformationRef must be set.","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForCreation","type":"object","description":"ServiceJobAdditionalInformationForCreation"},"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"},"ServiceJobLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"ServiceJobLineItemForCreation","type":"object","description":"ServiceJobLineItemForCreation"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"RequiredLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["article","quantity"],"title":"RequiredLineItemForCreation","type":"object","description":"RequiredLineItemForCreation"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"}}}}
```

## The ServiceJobInProgressActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobInProgressActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"name":{"description":"Name of the action to perform, must be 'StartServiceJob'","enum":["StartServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobInProgressActionParameter","type":"object","description":"ServiceJobInProgressActionParameter"},"ServiceJobAdditionalInformationForUpdate":{"properties":{"additionalInformationRef":{"description":"ID of the additional information","type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForUpdate","type":"object","description":"ServiceJobAdditionalInformationForUpdate"}}}}
```

## The ServiceJobLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"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":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The ServiceJobLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The ServiceJobLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"ServiceJobLineItemForCreation","type":"object","description":"ServiceJobLineItemForCreation"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"}}}}
```

## The ServiceJobLink object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"}}}}
```

## The ServiceJobLinkForAdding object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobLinkForAdding":{"properties":{"serviceJobRef":{"description":"ID of the service job to add to this linked service jobs group","minLength":1,"type":"string"}},"required":["serviceJobRef"],"title":"ServiceJobLinkForAdding","type":"object","description":"ServiceJobLinkForAdding"}}}}
```

## The ServiceJobLogCancellationPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobLogCancellationPayload":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLogPayload"}],"properties":{"statusInformationCancelReason":{"$ref":"#/components/schemas/ServiceJobStatusReason"}},"type":"object","title":"ServiceJobLogCancellationPayload","description":"ServiceJobLogCancellationPayload"},"ServiceJobLogPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"type":"string"}},"type":"object","title":"ServiceJobLogPayload","description":"ServiceJobLogPayload"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ServiceJobStatusReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"type":"string"}},"required":["reasonLocalized"],"type":"object","title":"ServiceJobStatusReason","description":"ServiceJobStatusReason"}}}}
```

## The ServiceJobLogPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobLogPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"type":"string"}},"type":"object","title":"ServiceJobLogPayload","description":"ServiceJobLogPayload"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ServiceJobObsoleteActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobObsoleteActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'ObsoleteServiceJob'","enum":["ObsoleteServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobObsoleteActionParameter","type":"object","description":"ServiceJobObsoleteActionParameter"}}}}
```

## The ServiceJobOpenActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobOpenActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"name":{"description":"Name of the action to perform, must be 'OpenServiceJob'","enum":["OpenServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobOpenActionParameter","type":"object","description":"ServiceJobOpenActionParameter"},"ServiceJobAdditionalInformationForUpdate":{"properties":{"additionalInformationRef":{"description":"ID of the additional information","type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForUpdate","type":"object","description":"ServiceJobAdditionalInformationForUpdate"}}}}
```

## The ServiceJobReplaceAssignedUsersActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobReplaceAssignedUsersActionParameter":{"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"maxItems":10,"type":"array"},"name":{"description":"Name of the action to perform, must be 'REPLACE_ASSIGNED_USERS'","enum":["REPLACE_ASSIGNED_USERS"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","assignedUsers"],"title":"ServiceJobReplaceAssignedUsersActionParameter","type":"object","description":"ServiceJobReplaceAssignedUsersActionParameter"},"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"}}}}
```

## The ServiceJobs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobs":{"properties":{"serviceJobs":{"description":"List of service jobs matching the query","items":{"$ref":"#/components/schemas/ServiceJobWithSearchPaths"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"ServiceJobs","type":"object","description":"ServiceJobs"},"ServiceJobWithSearchPaths":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformation"},"maxItems":15,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":10,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customServiceRef":{"description":"Id of the customService this ServiceJob was created from.","type":"string"},"description":{"description":"Translated description of this service job derived from descriptionLocalized","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"executionTimeInMin":{"description":"Time in minutes this service job is expected to take to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"id":{"description":"Unique ID of this service job","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images taken from the connected custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"inheritedLineItems":{"deprecated":true,"description":"deprecated: use availableLineItems on ServiceData instead","items":{"$ref":"#/components/schemas/InheritedServiceJobLineItem"},"maxItems":200,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing this service job","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items worked on in this service job are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItem"},"maxItems":50,"type":"array"},"linkedServiceJobsRef":{"description":"ID of the Linked Service Job, the Service Job should reference.","type":"string"},"name":{"description":"Translated name of this service job derived from nameLocalized","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the process this service job belongs to","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItem"},"maxItems":50,"type":"array"},"searchPaths":{"description":"Search paths used for full-text search indexing of this entity","items":{"type":"string"},"maxItems":200,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"status":{"description":"Current status of this service job","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"statusInformation":{"allOf":[{"$ref":"#/components/schemas/ServiceJobStatusInformation"}],"description":"Additional information about the current status of this service job"},"subStatus":{"description":"Additional sub-status information about this service job","enum":["LINE_ITEMS_MISSING","REQUIRED_LINE_ITEMS_UNFULFILLABLE"],"type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["customServiceRef","processRef","facilityRef","lineItems","targetTime","created","lastModified","version","id","status","nameLocalized","itemsRequired","searchPaths"],"title":"ServiceJobWithSearchPaths","type":"object","description":"ServiceJobWithSearchPaths"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"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"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"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":"Unique ID of this inherited line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"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":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"},"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"}}}}
```

## The ServiceJobSplitLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobSplitLineItemsActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'SPLIT_LINES_SERVICE_JOB'","enum":["SPLIT_LINES_SERVICE_JOB"],"type":"string"},"splitLineItemsInfo":{"description":"List of line item splits to perform, each specifying a line item and its new quantity","items":{"$ref":"#/components/schemas/ServiceJobSplitLineItemsInfo"},"maxItems":50,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","minimum":0,"type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"ServiceJobSplitLineItemsActionParameter","type":"object","description":"ServiceJobSplitLineItemsActionParameter"},"ServiceJobSplitLineItemsInfo":{"properties":{"lineItemId":{"description":"references the id of the lineItem of a serviceJob","type":"string"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"title":"ServiceJobSplitLineItemsInfo","type":"object","description":"ServiceJobSplitLineItemsInfo"}}}}
```

## The ServiceJobSplitLineItemsInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobSplitLineItemsInfo":{"properties":{"lineItemId":{"description":"references the id of the lineItem of a serviceJob","type":"string"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"title":"ServiceJobSplitLineItemsInfo","type":"object","description":"ServiceJobSplitLineItemsInfo"}}}}
```

## The ServiceJobStatusInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ServiceJobStatusReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobStatusReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"type":"string"}},"required":["reasonLocalized"],"type":"object","title":"ServiceJobStatusReason","description":"ServiceJobStatusReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ServiceJobWaitingForInputActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobWaitingForInputActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"name":{"description":"Name of the action to perform, must be 'HoldServiceJob'","enum":["HoldServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobWaitingForInputActionParameter","type":"object","description":"ServiceJobWaitingForInputActionParameter"},"ServiceJobAdditionalInformationForUpdate":{"properties":{"additionalInformationRef":{"description":"ID of the additional information","type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForUpdate","type":"object","description":"ServiceJobAdditionalInformationForUpdate"}}}}
```

## The ServiceJobWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ServiceJob"}},"required":["payload"],"type":"object","title":"ServiceJobWebHookEvent","description":"ServiceJobWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ServiceJob":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformation"},"maxItems":15,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":10,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customServiceRef":{"description":"Id of the customService this ServiceJob was created from.","type":"string"},"description":{"description":"Translated description of this service job derived from descriptionLocalized","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"executionTimeInMin":{"description":"Time in minutes this service job is expected to take to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"id":{"description":"Unique ID of this service job","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images taken from the connected custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"inheritedLineItems":{"deprecated":true,"description":"deprecated: use availableLineItems on ServiceData instead","items":{"$ref":"#/components/schemas/InheritedServiceJobLineItem"},"maxItems":200,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing this service job","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items worked on in this service job are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItem"},"maxItems":50,"type":"array"},"linkedServiceJobsRef":{"description":"ID of the Linked Service Job, the Service Job should reference.","type":"string"},"name":{"description":"Translated name of this service job derived from nameLocalized","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the process this service job belongs to","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItem"},"maxItems":50,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"status":{"description":"Current status of this service job","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"statusInformation":{"allOf":[{"$ref":"#/components/schemas/ServiceJobStatusInformation"}],"description":"Additional information about the current status of this service job"},"subStatus":{"description":"Additional sub-status information about this service job","enum":["LINE_ITEMS_MISSING","REQUIRED_LINE_ITEMS_UNFULFILLABLE"],"type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["customServiceRef","processRef","facilityRef","lineItems","targetTime","created","lastModified","version","id","status","nameLocalized","itemsRequired"],"title":"ServiceJob","type":"object","description":"ServiceJob"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"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"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"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":"Unique ID of this inherited line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"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":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"},"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"}}}}
```

## The ServiceJobWithSearchPaths object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ServiceJobWithSearchPaths":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformation"},"maxItems":15,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":10,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customServiceRef":{"description":"Id of the customService this ServiceJob was created from.","type":"string"},"description":{"description":"Translated description of this service job derived from descriptionLocalized","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"executionTimeInMin":{"description":"Time in minutes this service job is expected to take to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"id":{"description":"Unique ID of this service job","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images taken from the connected custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"inheritedLineItems":{"deprecated":true,"description":"deprecated: use availableLineItems on ServiceData instead","items":{"$ref":"#/components/schemas/InheritedServiceJobLineItem"},"maxItems":200,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing this service job","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items worked on in this service job are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItem"},"maxItems":50,"type":"array"},"linkedServiceJobsRef":{"description":"ID of the Linked Service Job, the Service Job should reference.","type":"string"},"name":{"description":"Translated name of this service job derived from nameLocalized","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the process this service job belongs to","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItem"},"maxItems":50,"type":"array"},"searchPaths":{"description":"Search paths used for full-text search indexing of this entity","items":{"type":"string"},"maxItems":200,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"status":{"description":"Current status of this service job","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"statusInformation":{"allOf":[{"$ref":"#/components/schemas/ServiceJobStatusInformation"}],"description":"Additional information about the current status of this service job"},"subStatus":{"description":"Additional sub-status information about this service job","enum":["LINE_ITEMS_MISSING","REQUIRED_LINE_ITEMS_UNFULFILLABLE"],"type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["customServiceRef","processRef","facilityRef","lineItems","targetTime","created","lastModified","version","id","status","nameLocalized","itemsRequired","searchPaths"],"title":"ServiceJobWithSearchPaths","type":"object","description":"ServiceJobWithSearchPaths"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"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"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"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":"Unique ID of this inherited line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"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":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"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. Ensure that no authentication is needed 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":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"},"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"}}}}
```

## The SetHandoverJobToWaitingForInputActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SetHandoverJobToWaitingForInputActionEnum":{"enum":["WAITING_FOR_INPUT"],"type":"string","title":"SetHandoverJobToWaitingForInputActionEnum","description":"SetHandoverJobToWaitingForInputActionEnum"}}}}
```

## The SetHandoverJobToWaitingForInputActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The SevenSendersCarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SevenSendersCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"trackAndTraceUrl":{"description":"Track and trace URL","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"},"warehouse":{"description":"Warehouse identifier","type":"string"}},"required":["version","carrierRef","returnLabel"],"title":"SevenSendersCarrierConfiguration","type":"object","description":"SevenSendersCarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The SftpConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SftpConfiguration":{"properties":{"useSftpForTandT":{"description":"Indicates if the carrier uses sftp for getting track and trace data","type":"boolean"}},"required":["useSftpForTandT"],"title":"SftpConfiguration","type":"object","description":"SftpConfiguration"}}}}
```

## The ShipFromStoreRerouteConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipFromStoreRerouteConfiguration":{"properties":{"active":{"type":"boolean"},"allowManualReroute":{"default":false,"deprecated":true,"description":"@deprecated This config property is deprecated since 26/02/24. Use GlobalManualRerouteConfiguration instead.","type":"boolean"},"facilityWideRerouteOnShortPick":{"default":false,"type":"boolean"},"rerouteTargetTime":{"description":"Only pickJobs where the targetTime in not larger than now plus this number are rerouted","type":"number"},"rerouteType":{"$ref":"#/components/schemas/RerouteType"}},"required":["active","rerouteType"],"type":"object","title":"ShipFromStoreRerouteConfiguration","description":"ShipFromStoreRerouteConfiguration"},"RerouteType":{"description":"The type of reroute to apply to the order\n  * `REROUTE`- the complete routing plan is rerouted.\n  * `ORDERSPLIT`- the order is splitted. The short picked line items will be moved to a new routing plan and rerouted","enum":["REROUTE","ORDERSPLIT"],"type":"string","title":"RerouteType"}}}}
```

## The Shipment object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Shipment":{"allOf":[{"$ref":"#/components/schemas/ShipmentForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"default":false,"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierKey":{"type":"string"},"hasActiveCarrier":{"default":true,"description":"Indicates if there is an active carrier configuration to fulfill this shipment","type":"boolean"},"id":{"description":"The id of this Shipment. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItem"},"type":"array"},"parcels":{"items":{"$ref":"#/components/schemas/StrippedParcel"},"type":"array"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","hasActiveCarrier","workflowInformation"],"type":"object"}],"title":"Shipment","description":"Shipment"},"ShipmentForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the shipment. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"description":"The reference to the facility which the shipment is assigned to.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The id of the facility reference.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"sourceAddress":{"$ref":"#/components/schemas/FacilityAddress"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"},"tenantOrderId":{"description":"Reference to the order in the tenant system.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["facilityRef","targetTime","orderDate"],"type":"object","xml":{"name":"Shipment"},"title":"ShipmentForCreation","description":"ShipmentForCreation"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"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"},"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"},"ShipmentLineItem":{"allOf":[{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"}},"required":["id"],"type":"object"}],"title":"ShipmentLineItem","description":"ShipmentLineItem"},"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"},"StrippedParcel":{"properties":{"carrierRef":{"description":"The reference to the carrier for which the parcel is assigned to","type":"string"},"carrierTrackingNumber":{"type":"string"},"parcelRef":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"}},"required":["parcelRef","carrierRef","status"],"type":"object","title":"StrippedParcel","description":"StrippedParcel"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The ShipmentActionsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/ShipmentSplitLineItemsActionParameter"},{"$ref":"#/components/schemas/UpdateShipmentLineItemRecordableAttributesActionParameter"},{"$ref":"#/components/schemas/ShipmentAddTargetTimeActionParameter"}],"title":"ShipmentActionsParameter","description":"ShipmentActionsParameter"},"ShipmentSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ShipmentSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/ShipmentSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"ShipmentSplitLineItemsActionParameter","type":"object","description":"ShipmentSplitLineItemsActionParameter"},"ShipmentSplitLineItemsActionEnum":{"enum":["SPLIT_LINE_LINES_SHIPMENT"],"type":"string","title":"ShipmentSplitLineItemsActionEnum","description":"ShipmentSplitLineItemsActionEnum"},"ShipmentSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the item of a shipment","type":"string"},"quantity":{"description":"quantity of the specific item that has been shipped","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"type":"object","title":"ShipmentSplitLineItemsInfo","description":"ShipmentSplitLineItemsInfo"},"UpdateShipmentLineItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdateShipmentLineItemRecordableAttributesActionEnum"},"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":"UpdateShipmentLineItemRecordableAttributesActionParameter","type":"object","description":"UpdateShipmentLineItemRecordableAttributesActionParameter"},"UpdateShipmentLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_SHIPMENT_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdateShipmentLineItemRecordableAttributesActionEnum","description":"UpdateShipmentLineItemRecordableAttributesActionEnum"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ShipmentAddTargetTimeActionParameter":{"additionalProperties":false,"description":"Action to add targetTime to a Shipment that has none. Will fail if targetTime is already set","properties":{"name":{"$ref":"#/components/schemas/ShipmentAddTargetTimeActionEnum"},"targetTime":{"description":"The target time you want set for the given shipment.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"ShipmentAddTargetTimeActionParameter","type":"object"},"ShipmentAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"ShipmentAddTargetTimeActionEnum","description":"ShipmentAddTargetTimeActionEnum"}}}}
```

## The ShipmentAddTargetTimeActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"ShipmentAddTargetTimeActionEnum","description":"ShipmentAddTargetTimeActionEnum"}}}}
```

## The ShipmentAddTargetTimeActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentAddTargetTimeActionParameter":{"additionalProperties":false,"description":"Action to add targetTime to a Shipment that has none. Will fail if targetTime is already set","properties":{"name":{"$ref":"#/components/schemas/ShipmentAddTargetTimeActionEnum"},"targetTime":{"description":"The target time you want set for the given shipment.","format":"date-time","type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","targetTime"],"title":"ShipmentAddTargetTimeActionParameter","type":"object"},"ShipmentAddTargetTimeActionEnum":{"enum":["ADD_TARGET_TIME"],"type":"string","title":"ShipmentAddTargetTimeActionEnum","description":"ShipmentAddTargetTimeActionEnum"}}}}
```

## The ShipmentForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the shipment. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"description":"The reference to the facility which the shipment is assigned to.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The id of the facility reference.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"sourceAddress":{"$ref":"#/components/schemas/FacilityAddress"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"},"tenantOrderId":{"description":"Reference to the order in the tenant system.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["facilityRef","targetTime","orderDate"],"type":"object","xml":{"name":"Shipment"},"title":"ShipmentForCreation","description":"ShipmentForCreation"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"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"}}}}
```

## The ShipmentLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentLineItem":{"allOf":[{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"}},"required":["id"],"type":"object"}],"title":"ShipmentLineItem","description":"ShipmentLineItem"},"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"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"}}}}
```

## The ShipmentLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The ShipmentLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The ShipmentOrderBy object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentOrderBy":{"description":"STATUS_TARGET_TIME_LAST_MODIFIED_DATE is depricated","enum":["STATUS_TARGET_TIME_ORDER_DATE"],"title":"ShipmentOrderBy"}}}}
```

## The ShipmentPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"shipments":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"},"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","shipments"],"title":"ShipmentPaginatedResult","type":"object","description":"ShipmentPaginatedResult"},"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"},"Shipment":{"allOf":[{"$ref":"#/components/schemas/ShipmentForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"default":false,"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierKey":{"type":"string"},"hasActiveCarrier":{"default":true,"description":"Indicates if there is an active carrier configuration to fulfill this shipment","type":"boolean"},"id":{"description":"The id of this Shipment. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItem"},"type":"array"},"parcels":{"items":{"$ref":"#/components/schemas/StrippedParcel"},"type":"array"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","hasActiveCarrier","workflowInformation"],"type":"object"}],"title":"Shipment","description":"Shipment"},"ShipmentForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the shipment. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"description":"The reference to the facility which the shipment is assigned to.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The id of the facility reference.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"sourceAddress":{"$ref":"#/components/schemas/FacilityAddress"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"},"tenantOrderId":{"description":"Reference to the order in the tenant system.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["facilityRef","targetTime","orderDate"],"type":"object","xml":{"name":"Shipment"},"title":"ShipmentForCreation","description":"ShipmentForCreation"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"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"},"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"},"ShipmentLineItem":{"allOf":[{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"}},"required":["id"],"type":"object"}],"title":"ShipmentLineItem","description":"ShipmentLineItem"},"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"},"StrippedParcel":{"properties":{"carrierRef":{"description":"The reference to the carrier for which the parcel is assigned to","type":"string"},"carrierTrackingNumber":{"type":"string"},"parcelRef":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"}},"required":["parcelRef","carrierRef","status"],"type":"object","title":"StrippedParcel","description":"StrippedParcel"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The ShipmentParcelsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentParcelsFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ShipmentParcelsFilter","type":"object","description":"ShipmentParcelsFilter"},"ShipmentParcelsParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ShipmentParcelsParcelStatusEnumFilter","type":"object","description":"ShipmentParcelsParcelStatusEnumFilter"}}}}
```

## The ShipmentParcelsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentParcelsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShipmentParcelsListFilter","type":"object","description":"ShipmentParcelsListFilter"},"ShipmentParcelsFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ShipmentParcelsFilter","type":"object","description":"ShipmentParcelsFilter"},"ShipmentParcelsParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ShipmentParcelsParcelStatusEnumFilter","type":"object","description":"ShipmentParcelsParcelStatusEnumFilter"}}}}
```

## The ShipmentParcelsParcelStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentParcelsParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ShipmentParcelsParcelStatusEnumFilter","type":"object","description":"ShipmentParcelsParcelStatusEnumFilter"}}}}
```

## The ShipmentPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentPatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyShipment"},"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":"ShipmentPatchActions"},"title":"ShipmentPatchActions","description":"ShipmentPatchActions"},"ModifyShipment":{"allOf":[{"additionalProperties":false,"properties":{"action":{"$ref":"#/components/schemas/ModifyShipmentActionEnum"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The reference to the pickjob for which the shipment is assigned to","type":"string"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyShipment"},"title":"ModifyShipment","description":"ModifyShipment"},"ModifyShipmentActionEnum":{"description":"Use value 'ModifyShipment', because you want to modify a shipment","enum":["ModifyShipment"],"type":"string","title":"ModifyShipmentActionEnum"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"},"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"},"maxItems":500,"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"}}}}
```

## The ShipmentSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentSearchPayload":{"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/ShipmentSearchQueryWrapper"},"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/ShipmentSort"},"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":"ShipmentSearchPayload","type":"object","description":"ShipmentSearchPayload"},"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"},"ShipmentSearchQueryWrapper":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by created"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"parcels":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsListFilter"}],"description":"Nested list search by parcels"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"required":["created"],"title":"ShipmentSearchQueryWrapper","type":"object","description":"ShipmentSearchQueryWrapper"},"ShipmentSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"parcels":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsListFilter"}],"description":"Nested list search by parcels"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ShipmentSearchQuery","type":"object","description":"ShipmentSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"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"},"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"},"ShipmentParcelsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShipmentParcelsListFilter","type":"object","description":"ShipmentParcelsListFilter"},"ShipmentParcelsFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ShipmentParcelsFilter","type":"object","description":"ShipmentParcelsFilter"},"ShipmentParcelsParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ShipmentParcelsParcelStatusEnumFilter","type":"object","description":"ShipmentParcelsParcelStatusEnumFilter"},"ShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ShipmentStatusEnumFilter","type":"object","description":"ShipmentStatusEnumFilter"},"ShipmentSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"ShipmentSort","type":"object","description":"ShipmentSort"}}}}
```

## The ShipmentSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"parcels":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsListFilter"}],"description":"Nested list search by parcels"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ShipmentSearchQuery","type":"object","description":"ShipmentSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"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"},"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"},"ShipmentParcelsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShipmentParcelsListFilter","type":"object","description":"ShipmentParcelsListFilter"},"ShipmentParcelsFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ShipmentParcelsFilter","type":"object","description":"ShipmentParcelsFilter"},"ShipmentParcelsParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ShipmentParcelsParcelStatusEnumFilter","type":"object","description":"ShipmentParcelsParcelStatusEnumFilter"},"ShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ShipmentStatusEnumFilter","type":"object","description":"ShipmentStatusEnumFilter"}}}}
```

## The ShipmentSearchQueryWrapper object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentSearchQueryWrapper":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by created"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"parcels":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsListFilter"}],"description":"Nested list search by parcels"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"required":["created"],"title":"ShipmentSearchQueryWrapper","type":"object","description":"ShipmentSearchQueryWrapper"},"ShipmentSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"parcels":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsListFilter"}],"description":"Nested list search by parcels"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ShipmentSearchQuery","type":"object","description":"ShipmentSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"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"},"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"},"ShipmentParcelsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShipmentParcelsListFilter","type":"object","description":"ShipmentParcelsListFilter"},"ShipmentParcelsFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ShipmentParcelsFilter","type":"object","description":"ShipmentParcelsFilter"},"ShipmentParcelsParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ShipmentParcelsParcelStatusEnumFilter","type":"object","description":"ShipmentParcelsParcelStatusEnumFilter"},"ShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ShipmentStatusEnumFilter","type":"object","description":"ShipmentStatusEnumFilter"}}}}
```

## The ShipmentSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"ShipmentSort","type":"object","description":"ShipmentSort"}}}}
```

## The ShipmentSplitLineItemsActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentSplitLineItemsActionEnum":{"enum":["SPLIT_LINE_LINES_SHIPMENT"],"type":"string","title":"ShipmentSplitLineItemsActionEnum","description":"ShipmentSplitLineItemsActionEnum"}}}}
```

## The ShipmentSplitLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ShipmentSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/ShipmentSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"ShipmentSplitLineItemsActionParameter","type":"object","description":"ShipmentSplitLineItemsActionParameter"},"ShipmentSplitLineItemsActionEnum":{"enum":["SPLIT_LINE_LINES_SHIPMENT"],"type":"string","title":"ShipmentSplitLineItemsActionEnum","description":"ShipmentSplitLineItemsActionEnum"},"ShipmentSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the item of a shipment","type":"string"},"quantity":{"description":"quantity of the specific item that has been shipped","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"type":"object","title":"ShipmentSplitLineItemsInfo","description":"ShipmentSplitLineItemsInfo"}}}}
```

## The ShipmentSplitLineItemsInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the item of a shipment","type":"string"},"quantity":{"description":"quantity of the specific item that has been shipped","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"type":"object","title":"ShipmentSplitLineItemsInfo","description":"ShipmentSplitLineItemsInfo"}}}}
```

## The ShipmentStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"}}}}
```

## The ShipmentStatusEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ShipmentStatusEnumFilter","type":"object","description":"ShipmentStatusEnumFilter"}}}}
```

## The ShipmentWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/Shipment"}},"required":["payload"],"type":"object","title":"ShipmentWebHookEvent","description":"ShipmentWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"Shipment":{"allOf":[{"$ref":"#/components/schemas/ShipmentForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"default":false,"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierKey":{"type":"string"},"hasActiveCarrier":{"default":true,"description":"Indicates if there is an active carrier configuration to fulfill this shipment","type":"boolean"},"id":{"description":"The id of this Shipment. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItem"},"type":"array"},"parcels":{"items":{"$ref":"#/components/schemas/StrippedParcel"},"type":"array"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","hasActiveCarrier","workflowInformation"],"type":"object"}],"title":"Shipment","description":"Shipment"},"ShipmentForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the shipment. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"description":"The reference to the facility which the shipment is assigned to.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The id of the facility reference.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"sourceAddress":{"$ref":"#/components/schemas/FacilityAddress"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"},"tenantOrderId":{"description":"Reference to the order in the tenant system.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["facilityRef","targetTime","orderDate"],"type":"object","xml":{"name":"Shipment"},"title":"ShipmentForCreation","description":"ShipmentForCreation"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"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"},"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"},"ShipmentLineItem":{"allOf":[{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"}},"required":["id"],"type":"object"}],"title":"ShipmentLineItem","description":"ShipmentLineItem"},"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"},"StrippedParcel":{"properties":{"carrierRef":{"description":"The reference to the carrier for which the parcel is assigned to","type":"string"},"carrierTrackingNumber":{"type":"string"},"parcelRef":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"}},"required":["parcelRef","carrierRef","status"],"type":"object","title":"StrippedParcel","description":"StrippedParcel"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The ShipmentWithSearchPath object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShipmentWithSearchPath":{"allOf":[{"$ref":"#/components/schemas/Shipment"},{"additionalProperties":false,"properties":{"searchPaths":{"items":{"type":"string"},"minItems":0,"type":"array"}},"type":"object"}],"title":"ShipmentWithSearchPath","description":"ShipmentWithSearchPath"},"Shipment":{"allOf":[{"$ref":"#/components/schemas/ShipmentForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"default":false,"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierKey":{"type":"string"},"hasActiveCarrier":{"default":true,"description":"Indicates if there is an active carrier configuration to fulfill this shipment","type":"boolean"},"id":{"description":"The id of this Shipment. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItem"},"type":"array"},"parcels":{"items":{"$ref":"#/components/schemas/StrippedParcel"},"type":"array"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","hasActiveCarrier","workflowInformation"],"type":"object"}],"title":"Shipment","description":"Shipment"},"ShipmentForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the shipment. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"description":"The reference to the facility which the shipment is assigned to.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The id of the facility reference.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"sourceAddress":{"$ref":"#/components/schemas/FacilityAddress"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"},"tenantOrderId":{"description":"Reference to the order in the tenant system.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["facilityRef","targetTime","orderDate"],"type":"object","xml":{"name":"Shipment"},"title":"ShipmentForCreation","description":"ShipmentForCreation"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"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"},"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"},"ShipmentLineItem":{"allOf":[{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"}},"required":["id"],"type":"object"}],"title":"ShipmentLineItem","description":"ShipmentLineItem"},"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"},"StrippedParcel":{"properties":{"carrierRef":{"description":"The reference to the carrier for which the parcel is assigned to","type":"string"},"carrierTrackingNumber":{"type":"string"},"parcelRef":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"}},"required":["parcelRef","carrierRef","status"],"type":"object","title":"StrippedParcel","description":"StrippedParcel"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The ShippingConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingConfiguration":{"properties":{"created":{"description":"Creation date of this shippingConfiguration","format":"date-time","type":"string"},"id":{"description":"Unique identifier of this shippingConfiguration","type":"string"},"lastModified":{"description":"Last modification date of this shippingConfiguration","format":"date-time","type":"string"},"recommendationConfiguration":{"allOf":[{"$ref":"#/components/schemas/RecommendationConfiguration"}],"description":"Configuration for the automatic carrier recommendation for shipments"},"version":{"description":"Version number of this shippingConfiguration","type":"number"}},"required":["id","version","created","lastModified"],"title":"ShippingConfiguration","type":"object","description":"ShippingConfiguration"},"RecommendationConfiguration":{"properties":{"priceType":{"description":"Defines the price attribute category of which the price value is taken for carrier recommendation calculation","enum":["customs","insurance","shop","salesPrice","basePrice","tax"],"type":"string"}},"required":["priceType"],"title":"RecommendationConfiguration","type":"object","description":"RecommendationConfiguration"}}}}
```

## The ShippingConfigurationForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingConfigurationForUpdate":{"properties":{"recommendationConfiguration":{"allOf":[{"$ref":"#/components/schemas/RecommendationConfiguration"}],"description":"Configuration for the automatic carrier recommendation for shipments"},"version":{"description":"Version number of this shippingConfiguration","type":"number"}},"required":["version"],"title":"ShippingConfigurationForUpdate","type":"object","description":"ShippingConfigurationForUpdate"},"RecommendationConfiguration":{"properties":{"priceType":{"description":"Defines the price attribute category of which the price value is taken for carrier recommendation calculation","enum":["customs","insurance","shop","salesPrice","basePrice","tax"],"type":"string"}},"required":["priceType"],"title":"RecommendationConfiguration","type":"object","description":"RecommendationConfiguration"}}}}
```

## The ShippingCosts object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The ShippingInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierRecipientInformation":{"description":"Combination of address, carrier, carrier product and carrier service which can be referenced by line items. At the moment only address is implemented and only one carrierRecipientInformation is allowed.","items":{"$ref":"#/components/schemas/CarrierRecipientInformation"},"maxItems":1,"minItems":1,"type":"array"},"created":{"description":"Creation date of this shippingInformation","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"Reference to related facility","type":"string"},"id":{"description":"Unique identifier of this shippingInformation","type":"string"},"lastModified":{"description":"Last modification date of this shippingInformation","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process. If not passed, a new operative process will be created and the reference added.","type":"string"},"processRef":{"description":"Reference to related process. If not passed, a new process will be created and the reference added.","type":"string"},"recommendedCarrier":{"allOf":[{"$ref":"#/components/schemas/RecommendedCarrier"}],"description":"Recommended carrier for this shippingInformation."},"senderAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Address of the sender for this shippingInformation"},"shippingInformationLineItems":{"description":"Items that are related to this shippingInformation","items":{"$ref":"#/components/schemas/ShippingInformationLineItem"},"maxItems":50,"minItems":0,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a shippingInformation to a customer","type":"string"},"status":{"description":"The status of the shippingInformation","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"},"version":{"description":"Version number of this shippingInformation","type":"number"}},"required":["id","version","created","lastModified","processRef","operativeProcessRef","facilityRef","status","carrierRecipientInformation","senderAddress","shippingInformationLineItems"],"title":"ShippingInformation","type":"object","description":"ShippingInformation"},"CarrierRecipientInformation":{"properties":{"address":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":3,"minItems":1,"type":"array"},"id":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","type":"string"}},"required":["id","address"],"title":"CarrierRecipientInformation","type":"object","description":"CarrierRecipientInformation"},"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"},"maxItems":500,"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"},"RecommendedCarrier":{"properties":{"carrierProduct":{"description":"Carrier product that has been selected.","type":"string"},"carrierRef":{"description":"Reference to the recommended carrier","type":"string"},"carrierServices":{"description":"Carrier services that have been selected","items":{"type":"string"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"RecommendedCarrier","type":"object","description":"RecommendedCarrier"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ShippingInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this shippingInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"number"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ShippingInformationLineItem","type":"object","description":"ShippingInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ShippingInformationCarrierRecipientInformationAddressFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationCarrierRecipientInformationAddressFilter":{"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":"ShippingInformationCarrierRecipientInformationAddressFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressFilter"},"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"}}}}
```

## The ShippingInformationCarrierRecipientInformationAddressListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationCarrierRecipientInformationAddressListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationCarrierRecipientInformationAddressListFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressListFilter"},"ShippingInformationCarrierRecipientInformationAddressFilter":{"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":"ShippingInformationCarrierRecipientInformationAddressFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressFilter"},"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"}}}}
```

## The ShippingInformationCarrierRecipientInformationFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationCarrierRecipientInformationFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressListFilter"}],"description":"Nested list search by address"}},"title":"ShippingInformationCarrierRecipientInformationFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationFilter"},"ShippingInformationCarrierRecipientInformationAddressListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationCarrierRecipientInformationAddressListFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressListFilter"},"ShippingInformationCarrierRecipientInformationAddressFilter":{"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":"ShippingInformationCarrierRecipientInformationAddressFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressFilter"},"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"}}}}
```

## The ShippingInformationCarrierRecipientInformationListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationCarrierRecipientInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationCarrierRecipientInformationListFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationListFilter"},"ShippingInformationCarrierRecipientInformationFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressListFilter"}],"description":"Nested list search by address"}},"title":"ShippingInformationCarrierRecipientInformationFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationFilter"},"ShippingInformationCarrierRecipientInformationAddressListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationCarrierRecipientInformationAddressListFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressListFilter"},"ShippingInformationCarrierRecipientInformationAddressFilter":{"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":"ShippingInformationCarrierRecipientInformationAddressFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressFilter"},"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"}}}}
```

## The ShippingInformationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationForCreation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierRecipientInformation":{"description":"Combination of address, carrier, carrier product and carrier service which can be referenced by line items. At the moment only address is implemented and only one carrierRecipientInformation is allowed.","items":{"$ref":"#/components/schemas/CarrierRecipientInformationForCreation"},"maxItems":1,"minItems":1,"type":"array"},"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"},"facilityRef":{"description":"Reference to related facility","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process. If not passed, a new operative process will be created and the reference added.","type":"string"},"processRef":{"description":"Reference to related process. If not passed, a new process will be created and the reference added.","type":"string"},"recommendedCarrier":{"allOf":[{"$ref":"#/components/schemas/RecommendedCarrier"}],"description":"Recommended carrier for this shippingInformation."},"senderAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Address of the sender for this shippingInformation"},"shippingInformationLineItems":{"description":"Items that are related to this shippingInformation","items":{"$ref":"#/components/schemas/ShippingInformationLineItemForCreation"},"maxItems":50,"minItems":0,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a shippingInformation to a customer","type":"string"},"status":{"description":"The status of the shippingInformation","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"}},"required":["facilityRef","senderAddress","shippingInformationLineItems","carrierRecipientInformation"],"title":"ShippingInformationForCreation","type":"object","description":"ShippingInformationForCreation"},"CarrierRecipientInformationForCreation":{"properties":{"address":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":3,"minItems":1,"type":"array"}},"required":["address"],"title":"CarrierRecipientInformationForCreation","type":"object","description":"CarrierRecipientInformationForCreation"},"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"},"maxItems":500,"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"},"RecommendedCarrier":{"properties":{"carrierProduct":{"description":"Carrier product that has been selected.","type":"string"},"carrierRef":{"description":"Reference to the recommended carrier","type":"string"},"carrierServices":{"description":"Carrier services that have been selected","items":{"type":"string"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"RecommendedCarrier","type":"object","description":"RecommendedCarrier"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ShippingInformationLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"number"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"ShippingInformationLineItemForCreation","type":"object","description":"ShippingInformationLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ShippingInformationLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this shippingInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"number"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ShippingInformationLineItem","type":"object","description":"ShippingInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ShippingInformationLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"number"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"ShippingInformationLineItemForCreation","type":"object","description":"ShippingInformationLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ShippingInformationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"shippingInformationList":{"items":{"$ref":"#/components/schemas/ShippingInformation"},"type":"array"},"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","shippingInformationList"],"title":"ShippingInformationPaginatedResult","type":"object","description":"ShippingInformationPaginatedResult"},"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"},"ShippingInformation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierRecipientInformation":{"description":"Combination of address, carrier, carrier product and carrier service which can be referenced by line items. At the moment only address is implemented and only one carrierRecipientInformation is allowed.","items":{"$ref":"#/components/schemas/CarrierRecipientInformation"},"maxItems":1,"minItems":1,"type":"array"},"created":{"description":"Creation date of this shippingInformation","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"Reference to related facility","type":"string"},"id":{"description":"Unique identifier of this shippingInformation","type":"string"},"lastModified":{"description":"Last modification date of this shippingInformation","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process. If not passed, a new operative process will be created and the reference added.","type":"string"},"processRef":{"description":"Reference to related process. If not passed, a new process will be created and the reference added.","type":"string"},"recommendedCarrier":{"allOf":[{"$ref":"#/components/schemas/RecommendedCarrier"}],"description":"Recommended carrier for this shippingInformation."},"senderAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Address of the sender for this shippingInformation"},"shippingInformationLineItems":{"description":"Items that are related to this shippingInformation","items":{"$ref":"#/components/schemas/ShippingInformationLineItem"},"maxItems":50,"minItems":0,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a shippingInformation to a customer","type":"string"},"status":{"description":"The status of the shippingInformation","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"},"version":{"description":"Version number of this shippingInformation","type":"number"}},"required":["id","version","created","lastModified","processRef","operativeProcessRef","facilityRef","status","carrierRecipientInformation","senderAddress","shippingInformationLineItems"],"title":"ShippingInformation","type":"object","description":"ShippingInformation"},"CarrierRecipientInformation":{"properties":{"address":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":3,"minItems":1,"type":"array"},"id":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","type":"string"}},"required":["id","address"],"title":"CarrierRecipientInformation","type":"object","description":"CarrierRecipientInformation"},"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"},"maxItems":500,"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"},"RecommendedCarrier":{"properties":{"carrierProduct":{"description":"Carrier product that has been selected.","type":"string"},"carrierRef":{"description":"Reference to the recommended carrier","type":"string"},"carrierServices":{"description":"Carrier services that have been selected","items":{"type":"string"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"RecommendedCarrier","type":"object","description":"RecommendedCarrier"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ShippingInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this shippingInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"number"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ShippingInformationLineItem","type":"object","description":"ShippingInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ShippingInformationResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationResponse":{"properties":{"shippingInformation":{"description":"the shipping information entities found by the given search criteria","items":{"$ref":"#/components/schemas/ShippingInformation"},"maxItems":500,"type":"array"},"total":{"description":"the total count of shipping information entities found by the given search criteria","type":"integer"}},"title":"ShippingInformationResponse","type":"object","description":"ShippingInformationResponse"},"ShippingInformation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierRecipientInformation":{"description":"Combination of address, carrier, carrier product and carrier service which can be referenced by line items. At the moment only address is implemented and only one carrierRecipientInformation is allowed.","items":{"$ref":"#/components/schemas/CarrierRecipientInformation"},"maxItems":1,"minItems":1,"type":"array"},"created":{"description":"Creation date of this shippingInformation","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"Reference to related facility","type":"string"},"id":{"description":"Unique identifier of this shippingInformation","type":"string"},"lastModified":{"description":"Last modification date of this shippingInformation","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process. If not passed, a new operative process will be created and the reference added.","type":"string"},"processRef":{"description":"Reference to related process. If not passed, a new process will be created and the reference added.","type":"string"},"recommendedCarrier":{"allOf":[{"$ref":"#/components/schemas/RecommendedCarrier"}],"description":"Recommended carrier for this shippingInformation."},"senderAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Address of the sender for this shippingInformation"},"shippingInformationLineItems":{"description":"Items that are related to this shippingInformation","items":{"$ref":"#/components/schemas/ShippingInformationLineItem"},"maxItems":50,"minItems":0,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a shippingInformation to a customer","type":"string"},"status":{"description":"The status of the shippingInformation","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"},"version":{"description":"Version number of this shippingInformation","type":"number"}},"required":["id","version","created","lastModified","processRef","operativeProcessRef","facilityRef","status","carrierRecipientInformation","senderAddress","shippingInformationLineItems"],"title":"ShippingInformation","type":"object","description":"ShippingInformation"},"CarrierRecipientInformation":{"properties":{"address":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":3,"minItems":1,"type":"array"},"id":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","type":"string"}},"required":["id","address"],"title":"CarrierRecipientInformation","type":"object","description":"CarrierRecipientInformation"},"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"},"maxItems":500,"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"},"RecommendedCarrier":{"properties":{"carrierProduct":{"description":"Carrier product that has been selected.","type":"string"},"carrierRef":{"description":"Reference to the recommended carrier","type":"string"},"carrierServices":{"description":"Carrier services that have been selected","items":{"type":"string"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"RecommendedCarrier","type":"object","description":"RecommendedCarrier"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ShippingInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this shippingInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"number"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ShippingInformationLineItem","type":"object","description":"ShippingInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ShippingInformationSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationSearchPayload":{"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/ShippingInformationSearchQuery"},"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/ShippingInformationSort"},"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":"ShippingInformationSearchPayload","type":"object","description":"ShippingInformationSearchPayload"},"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"},"ShippingInformationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ShippingInformationSearchQuery"},"maxItems":500,"type":"array"},"carrierRecipientInformation":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationListFilter"}],"description":"Nested list search by carrierRecipientInformation"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/ShippingInformationSearchQuery"},"maxItems":500,"type":"array"},"shippingInformationLineItems":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsListFilter"}],"description":"Nested list search by shippingInformationLineItems"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ShippingInformationSearchQuery","type":"object","description":"ShippingInformationSearchQuery"},"ShippingInformationCarrierRecipientInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationCarrierRecipientInformationListFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationListFilter"},"ShippingInformationCarrierRecipientInformationFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressListFilter"}],"description":"Nested list search by address"}},"title":"ShippingInformationCarrierRecipientInformationFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationFilter"},"ShippingInformationCarrierRecipientInformationAddressListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationCarrierRecipientInformationAddressListFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressListFilter"},"ShippingInformationCarrierRecipientInformationAddressFilter":{"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":"ShippingInformationCarrierRecipientInformationAddressFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressFilter"},"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"},"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"},"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"},"ShippingInformationShippingInformationLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationShippingInformationLineItemsListFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsListFilter"},"ShippingInformationShippingInformationLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ShippingInformationShippingInformationLineItemsFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsFilter"},"ShippingInformationShippingInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ShippingInformationShippingInformationLineItemsArticleFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsArticleFilter"},"ShippingInformationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ShippingInformationSort","type":"object","description":"ShippingInformationSort"}}}}
```

## The ShippingInformationSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ShippingInformationSearchQuery"},"maxItems":500,"type":"array"},"carrierRecipientInformation":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationListFilter"}],"description":"Nested list search by carrierRecipientInformation"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/ShippingInformationSearchQuery"},"maxItems":500,"type":"array"},"shippingInformationLineItems":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsListFilter"}],"description":"Nested list search by shippingInformationLineItems"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ShippingInformationSearchQuery","type":"object","description":"ShippingInformationSearchQuery"},"ShippingInformationCarrierRecipientInformationListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationCarrierRecipientInformationListFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationListFilter"},"ShippingInformationCarrierRecipientInformationFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressListFilter"}],"description":"Nested list search by address"}},"title":"ShippingInformationCarrierRecipientInformationFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationFilter"},"ShippingInformationCarrierRecipientInformationAddressListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationCarrierRecipientInformationAddressFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationCarrierRecipientInformationAddressListFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressListFilter"},"ShippingInformationCarrierRecipientInformationAddressFilter":{"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":"ShippingInformationCarrierRecipientInformationAddressFilter","type":"object","description":"ShippingInformationCarrierRecipientInformationAddressFilter"},"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"},"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"},"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"},"ShippingInformationShippingInformationLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationShippingInformationLineItemsListFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsListFilter"},"ShippingInformationShippingInformationLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ShippingInformationShippingInformationLineItemsFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsFilter"},"ShippingInformationShippingInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ShippingInformationShippingInformationLineItemsArticleFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsArticleFilter"}}}}
```

## The ShippingInformationShippingInformationLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationShippingInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ShippingInformationShippingInformationLineItemsArticleFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsArticleFilter"},"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"}}}}
```

## The ShippingInformationShippingInformationLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationShippingInformationLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ShippingInformationShippingInformationLineItemsFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsFilter"},"ShippingInformationShippingInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ShippingInformationShippingInformationLineItemsArticleFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsArticleFilter"},"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"}}}}
```

## The ShippingInformationShippingInformationLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationShippingInformationLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShippingInformationShippingInformationLineItemsListFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsListFilter"},"ShippingInformationShippingInformationLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ShippingInformationShippingInformationLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ShippingInformationShippingInformationLineItemsFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsFilter"},"ShippingInformationShippingInformationLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ShippingInformationShippingInformationLineItemsArticleFilter","type":"object","description":"ShippingInformationShippingInformationLineItemsArticleFilter"},"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"}}}}
```

## The ShippingInformationSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ShippingInformationSort","type":"object","description":"ShippingInformationSort"}}}}
```

## The ShippingInformationWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShippingInformationWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ShippingInformation"}},"required":["payload"],"type":"object","title":"ShippingInformationWebHookEvent","description":"ShippingInformationWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ShippingInformation":{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierRecipientInformation":{"description":"Combination of address, carrier, carrier product and carrier service which can be referenced by line items. At the moment only address is implemented and only one carrierRecipientInformation is allowed.","items":{"$ref":"#/components/schemas/CarrierRecipientInformation"},"maxItems":1,"minItems":1,"type":"array"},"created":{"description":"Creation date of this shippingInformation","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"Reference to related facility","type":"string"},"id":{"description":"Unique identifier of this shippingInformation","type":"string"},"lastModified":{"description":"Last modification date of this shippingInformation","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to related operative process. If not passed, a new operative process will be created and the reference added.","type":"string"},"processRef":{"description":"Reference to related process. If not passed, a new process will be created and the reference added.","type":"string"},"recommendedCarrier":{"allOf":[{"$ref":"#/components/schemas/RecommendedCarrier"}],"description":"Recommended carrier for this shippingInformation."},"senderAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Address of the sender for this shippingInformation"},"shippingInformationLineItems":{"description":"Items that are related to this shippingInformation","items":{"$ref":"#/components/schemas/ShippingInformationLineItem"},"maxItems":50,"minItems":0,"type":"array"},"shortId":{"description":"A short identifier that helps assigning a shippingInformation to a customer","type":"string"},"status":{"description":"The status of the shippingInformation","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"},"version":{"description":"Version number of this shippingInformation","type":"number"}},"required":["id","version","created","lastModified","processRef","operativeProcessRef","facilityRef","status","carrierRecipientInformation","senderAddress","shippingInformationLineItems"],"title":"ShippingInformation","type":"object","description":"ShippingInformation"},"CarrierRecipientInformation":{"properties":{"address":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":3,"minItems":1,"type":"array"},"id":{"description":"Addresses of the recipients for this carrierRecipientInformation. Depending on the use case there can be multiple recipient addresses (e.g. invoice address deviates from shipping address).","type":"string"}},"required":["id","address"],"title":"CarrierRecipientInformation","type":"object","description":"CarrierRecipientInformation"},"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"},"maxItems":500,"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"},"RecommendedCarrier":{"properties":{"carrierProduct":{"description":"Carrier product that has been selected.","type":"string"},"carrierRef":{"description":"Reference to the recommended carrier","type":"string"},"carrierServices":{"description":"Carrier services that have been selected","items":{"type":"string"},"maxItems":20,"type":"array"}},"required":["carrierRef"],"title":"RecommendedCarrier","type":"object","description":"RecommendedCarrier"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ShippingInformationLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Article information for this line item."},"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"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities. If not passed, a new one will be generated.","type":"string"},"id":{"description":"Unique identifier of this shippingInformationLineItem","type":"string"},"quantity":{"description":"Quantity of this item","minimum":1,"type":"number"},"recordableAttributes":{"description":"Customizable information about the item that can be set during the process","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"minItems":0,"type":"array"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"maxItems":50,"minItems":0,"type":"array"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["id","article","quantity"],"title":"ShippingInformationLineItem","type":"object","description":"ShippingInformationLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"}}}}
```

## The ShortPickReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"active":{"description":"Flag to mark a reason as active or inactive","type":"boolean"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["active","reasonLocalized"],"title":"ShortPickReason","description":"ShortPickReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The ShortPickReasonForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ShortPickReasonForUpsert":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object","title":"ShortPickReasonForUpsert","description":"ShortPickReasonForUpsert"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The SignatureCompanyAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SignatureCompanyAddress":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"houseNumber":{"type":"string"},"name":{"description":"Name of the retailer/company.","type":"string"},"postalCode":{"type":"string"},"street":{"type":"string"}},"required":["name","street","houseNumber","postalCode","city","country"],"title":"SignatureCompanyAddress","type":"object","description":"SignatureCompanyAddress"}}}}
```

## The SignatureDeliveryAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SignatureDeliveryAddress":{"properties":{"city":{"type":"string"},"companyName":{"type":"string"},"firstName":{"type":"string"},"houseNumber":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"postalCode":{"type":"string"},"street":{"type":"string"}},"required":["street","houseNumber","postalCode","city"],"title":"SignatureDeliveryAddress","type":"object","description":"SignatureDeliveryAddress"}}}}
```

## The SignatureForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SignatureForCreation":{"properties":{"companyAddress":{"allOf":[{"$ref":"#/components/schemas/SignatureCompanyAddress"}],"description":"Address of the retailer issuing the receipt."},"deliveryAddress":{"allOf":[{"$ref":"#/components/schemas/SignatureDeliveryAddress"}],"description":"Address of the customer the receipt is printed for."},"facilityName":{"description":"Name of the specific facility the customer picked up the order from.","type":"string"},"facilityTimeZoneId":{"description":"IANA time zone id for setting the signed time. If not present defaulted to Europe/Berlin.","pattern":"^[A-Za-z_]+(?:/[A-Za-z0-9_+-]+){0,2}$","type":"string"},"items":{"items":{"$ref":"#/components/schemas/SignatureItem"},"maxItems":100,"type":"array"},"orderInformation":{"$ref":"#/components/schemas/SignatureOrderInformation"},"pickupDateTime":{"description":"Date and time the customer picked up the order, fixing the moment the risk passes (§ 446 BGB).","format":"date-time","type":"string"},"signatureImage":{"allOf":[{"$ref":"#/components/schemas/SignatureImage"}],"description":"The signature image to draw into the signature rectangle. Optional, but if provided both base64 and type must be set."},"signeeName":{"description":"Name of the person who signed for and picked up the order.","type":"string"}},"required":["companyAddress","facilityName","orderInformation","deliveryAddress","items","pickupDateTime","signeeName"],"title":"SignatureForCreation","type":"object","description":"SignatureForCreation"},"SignatureCompanyAddress":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"houseNumber":{"type":"string"},"name":{"description":"Name of the retailer/company.","type":"string"},"postalCode":{"type":"string"},"street":{"type":"string"}},"required":["name","street","houseNumber","postalCode","city","country"],"title":"SignatureCompanyAddress","type":"object","description":"SignatureCompanyAddress"},"SignatureDeliveryAddress":{"properties":{"city":{"type":"string"},"companyName":{"type":"string"},"firstName":{"type":"string"},"houseNumber":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"postalCode":{"type":"string"},"street":{"type":"string"}},"required":["street","houseNumber","postalCode","city"],"title":"SignatureDeliveryAddress","type":"object","description":"SignatureDeliveryAddress"},"SignatureItem":{"properties":{"id":{"type":"string"},"quantity":{"type":"string"},"substitutes":{"description":"Title of the item which is substituted through this item.","type":"string"},"title":{"type":"string"}},"required":["id","title","quantity"],"title":"SignatureItem","type":"object","description":"SignatureItem"},"SignatureOrderInformation":{"properties":{"orderDate":{"description":"The date the order was created.","format":"date-time","type":"string"},"orderNumber":{"description":"An identifier for the order (tenantOrderId or a shorter order number).","type":"string"}},"required":["orderNumber"],"title":"SignatureOrderInformation","type":"object","description":"SignatureOrderInformation"},"SignatureImage":{"properties":{"fileContent":{"description":"Base64-encoded signature (PNG, JPG/JPEG image, or single-page PDF) to draw into the signature rectangle.","type":"string"},"type":{"description":"File type of base64.","enum":["PNG","JPG","JPEG","PDF"],"type":"string"}},"required":["fileContent","type"],"title":"SignatureImage","type":"object","description":"SignatureImage"}}}}
```

## The SignatureImage object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SignatureImage":{"properties":{"fileContent":{"description":"Base64-encoded signature (PNG, JPG/JPEG image, or single-page PDF) to draw into the signature rectangle.","type":"string"},"type":{"description":"File type of base64.","enum":["PNG","JPG","JPEG","PDF"],"type":"string"}},"required":["fileContent","type"],"title":"SignatureImage","type":"object","description":"SignatureImage"}}}}
```

## The SignatureItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SignatureItem":{"properties":{"id":{"type":"string"},"quantity":{"type":"string"},"substitutes":{"description":"Title of the item which is substituted through this item.","type":"string"},"title":{"type":"string"}},"required":["id","title","quantity"],"title":"SignatureItem","type":"object","description":"SignatureItem"}}}}
```

## The SignatureOrderInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SignatureOrderInformation":{"properties":{"orderDate":{"description":"The date the order was created.","format":"date-time","type":"string"},"orderNumber":{"description":"An identifier for the order (tenantOrderId or a shorter order number).","type":"string"}},"required":["orderNumber"],"title":"SignatureOrderInformation","type":"object","description":"SignatureOrderInformation"}}}}
```

## The SimulationOrder object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrder":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer","description":"Consumer information for the order"},"created":{"description":"Timestamp when the simulation order was created","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the order","type":"object"},"customServices":{"description":"Custom services for the order","items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences","description":"Delivery preferences for the order"},"id":{"description":"Unique identifier of the simulation order","type":"string"},"lastModified":{"description":"Timestamp when the simulation order was last modified","format":"date-time","type":"string"},"orderDate":{"description":"The date this order was created at the supplying system","format":"date-time","type":"string"},"orderLineItems":{"description":"Line items in the order","items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation","description":"Payment information for the order"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"Pricing information for the order"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions","description":"Promise options for the order"},"status":{"description":"Status of the order","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"statusReasons":{"description":"Status reasons for the order","items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"description":"Stickers associated with the order","items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"type":"array"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"number"},"tags":{"description":"Tags associated with the order","items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"type":"array"}},"required":["consumer","orderDate","orderLineItems","id","version","created","lastModified"],"title":"SimulationOrder","type":"object","description":"SimulationOrder"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The SimulationOrderConsumerAddressesAddressTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"SimulationOrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"SimulationOrderConsumerAddressesAddressTypeEnumFilter"}}}}
```

## The SimulationOrderConsumerAddressesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"SimulationOrderConsumerAddressesFilter","type":"object","description":"SimulationOrderConsumerAddressesFilter"},"SimulationOrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"SimulationOrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"SimulationOrderConsumerAddressesAddressTypeEnumFilter"},"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"}}}}
```

## The SimulationOrderConsumerAddressesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderConsumerAddressesListFilter","type":"object","description":"SimulationOrderConsumerAddressesListFilter"},"SimulationOrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"SimulationOrderConsumerAddressesFilter","type":"object","description":"SimulationOrderConsumerAddressesFilter"},"SimulationOrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"SimulationOrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"SimulationOrderConsumerAddressesAddressTypeEnumFilter"},"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"}}}}
```

## The SimulationOrderConsumerFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"SimulationOrderConsumerFilter","type":"object","description":"SimulationOrderConsumerFilter"},"SimulationOrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderConsumerAddressesListFilter","type":"object","description":"SimulationOrderConsumerAddressesListFilter"},"SimulationOrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"SimulationOrderConsumerAddressesFilter","type":"object","description":"SimulationOrderConsumerAddressesFilter"},"SimulationOrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"SimulationOrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"SimulationOrderConsumerAddressesAddressTypeEnumFilter"},"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"}}}}
```

## The SimulationOrderDeliveryPreferencesCollectFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"SimulationOrderDeliveryPreferencesCollectFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"}}}}
```

## The SimulationOrderDeliveryPreferencesCollectListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderDeliveryPreferencesCollectListFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectListFilter"},"SimulationOrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"SimulationOrderDeliveryPreferencesCollectFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"}}}}
```

## The SimulationOrderDeliveryPreferencesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"}},"title":"SimulationOrderDeliveryPreferencesFilter","type":"object","description":"SimulationOrderDeliveryPreferencesFilter"},"SimulationOrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderDeliveryPreferencesCollectListFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectListFilter"},"SimulationOrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"SimulationOrderDeliveryPreferencesCollectFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectFilter"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"SimulationOrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"SimulationOrderDeliveryPreferencesShippingFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingFilter"},"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"},"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"}}}}
```

## The SimulationOrderDeliveryPreferencesShippingFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"SimulationOrderDeliveryPreferencesShippingFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingFilter"},"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"},"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"}}}}
```

## The SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"}}}}
```

## The SimulationOrderForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderForCreation":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer","description":"Consumer information for the order"},"customAttributes":{"description":"Attributes that can be added to the order","type":"object"},"customServices":{"description":"Custom services for the order","items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences","description":"Delivery preferences for the order"},"orderDate":{"description":"The date this order was created at the supplying system","format":"date-time","type":"string"},"orderLineItems":{"description":"Line items in the order","items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation","description":"Payment information for the order"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"Pricing information for the order"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions","description":"Promise options for the order"},"status":{"description":"Status of the order","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"statusReasons":{"description":"Status reasons for the order","items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"description":"Stickers associated with the order","items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"type":"array"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"tags":{"description":"Tags associated with the order","items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"type":"array"}},"required":["consumer","orderDate","orderLineItems"],"title":"SimulationOrderForCreation","type":"object","description":"SimulationOrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The SimulationOrderForPartialUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderForPartialUpdate":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer","description":"Consumer information for the order"},"customAttributes":{"description":"Attributes that can be added to the order","type":"object"},"customServices":{"description":"Custom services for the order","items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences","description":"Delivery preferences for the order"},"orderDate":{"description":"The date this order was created at the supplying system","format":"date-time","type":"string"},"orderLineItems":{"description":"Line items in the order","items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation","description":"Payment information for the order"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"Pricing information for the order"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions","description":"Promise options for the order"},"status":{"description":"Status of the order","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"statusReasons":{"description":"Status reasons for the order","items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"description":"Stickers associated with the order","items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"type":"array"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"number"},"tags":{"description":"Tags associated with the order","items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"type":"array"}},"required":["version"],"title":"SimulationOrderForPartialUpdate","type":"object","description":"SimulationOrderForPartialUpdate"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The SimulationOrderForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderForUpdate":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer","description":"Consumer information for the order"},"customAttributes":{"description":"Attributes that can be added to the order","type":"object"},"customServices":{"description":"Custom services for the order","items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences","description":"Delivery preferences for the order"},"orderDate":{"description":"The date this order was created at the supplying system","format":"date-time","type":"string"},"orderLineItems":{"description":"Line items in the order","items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation","description":"Payment information for the order"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"Pricing information for the order"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions","description":"Promise options for the order"},"status":{"description":"Status of the order","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"statusReasons":{"description":"Status reasons for the order","items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"description":"Stickers associated with the order","items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"type":"array"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"number"},"tags":{"description":"Tags associated with the order","items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"type":"array"}},"required":["consumer","orderDate","orderLineItems","version"],"title":"SimulationOrderForUpdate","type":"object","description":"SimulationOrderForUpdate"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The SimulationOrderOrderLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"SimulationOrderOrderLineItemsArticleFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleFilter"},"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"},"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"}}}}
```

## The SimulationOrderOrderLineItemsArticleTitleLocalizedFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"},"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"}}}}
```

## The SimulationOrderOrderLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"SimulationOrderOrderLineItemsFilter","type":"object","description":"SimulationOrderOrderLineItemsFilter"},"SimulationOrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"SimulationOrderOrderLineItemsArticleFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleFilter"},"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"},"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"}}}}
```

## The SimulationOrderOrderLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderOrderLineItemsListFilter","type":"object","description":"SimulationOrderOrderLineItemsListFilter"},"SimulationOrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"SimulationOrderOrderLineItemsFilter","type":"object","description":"SimulationOrderOrderLineItemsFilter"},"SimulationOrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"SimulationOrderOrderLineItemsArticleFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleFilter"},"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"},"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"}}}}
```

## The SimulationOrderPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"simulationOrders":{"items":{"$ref":"#/components/schemas/SimulationOrder"},"type":"array"},"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","simulationOrders"],"title":"SimulationOrderPaginatedResult","type":"object","description":"SimulationOrderPaginatedResult"},"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"},"SimulationOrder":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer","description":"Consumer information for the order"},"created":{"description":"Timestamp when the simulation order was created","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the order","type":"object"},"customServices":{"description":"Custom services for the order","items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences","description":"Delivery preferences for the order"},"id":{"description":"Unique identifier of the simulation order","type":"string"},"lastModified":{"description":"Timestamp when the simulation order was last modified","format":"date-time","type":"string"},"orderDate":{"description":"The date this order was created at the supplying system","format":"date-time","type":"string"},"orderLineItems":{"description":"Line items in the order","items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation","description":"Payment information for the order"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"Pricing information for the order"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions","description":"Promise options for the order"},"status":{"description":"Status of the order","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"statusReasons":{"description":"Status reasons for the order","items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"description":"Stickers associated with the order","items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"type":"array"},"tenantOrderId":{"description":"Tenant-specific order identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"number"},"tags":{"description":"Tags associated with the order","items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"type":"array"}},"required":["consumer","orderDate","orderLineItems","id","version","created","lastModified"],"title":"SimulationOrder","type":"object","description":"SimulationOrder"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"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"},"maxItems":500,"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"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The SimulationOrderPaymentInfoFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderPaymentInfoFilter":{"properties":{"methodLocalized":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderPaymentInfoMethodLocalizedFilter"}],"description":"Nested search by methodLocalized"},"currency":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by currency"},"method":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by method"}},"title":"SimulationOrderPaymentInfoFilter","type":"object","description":"SimulationOrderPaymentInfoFilter"},"SimulationOrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderPaymentInfoMethodLocalizedFilter","type":"object","description":"SimulationOrderPaymentInfoMethodLocalizedFilter"},"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"}}}}
```

## The SimulationOrderPaymentInfoMethodLocalizedFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderPaymentInfoMethodLocalizedFilter","type":"object","description":"SimulationOrderPaymentInfoMethodLocalizedFilter"},"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"}}}}
```

## The SimulationOrderSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderSearchPayload":{"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/SimulationOrderSearchQuery"},"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/SimulationOrderSort"},"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":"SimulationOrderSearchPayload","type":"object","description":"SimulationOrderSearchPayload"},"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"},"SimulationOrderSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/SimulationOrderSearchQuery"},"maxItems":500,"type":"array"},"consumer":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerFilter"}],"description":"Nested search by consumer"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"deliveryPreferences":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesFilter"}],"description":"Nested search by deliveryPreferences"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/SimulationOrderSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"orderLineItems":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsListFilter"}],"description":"Nested list search by orderLineItems"},"paymentInfo":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderPaymentInfoFilter"}],"description":"Nested search by paymentInfo"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"},"tags":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderTagsListFilter"}],"description":"Nested list search by tags"}},"title":"SimulationOrderSearchQuery","type":"object","description":"SimulationOrderSearchQuery"},"SimulationOrderConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"SimulationOrderConsumerFilter","type":"object","description":"SimulationOrderConsumerFilter"},"SimulationOrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderConsumerAddressesListFilter","type":"object","description":"SimulationOrderConsumerAddressesListFilter"},"SimulationOrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"SimulationOrderConsumerAddressesFilter","type":"object","description":"SimulationOrderConsumerAddressesFilter"},"SimulationOrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"SimulationOrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"SimulationOrderConsumerAddressesAddressTypeEnumFilter"},"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"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"SimulationOrderDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"}},"title":"SimulationOrderDeliveryPreferencesFilter","type":"object","description":"SimulationOrderDeliveryPreferencesFilter"},"SimulationOrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderDeliveryPreferencesCollectListFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectListFilter"},"SimulationOrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"SimulationOrderDeliveryPreferencesCollectFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectFilter"},"SimulationOrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"SimulationOrderDeliveryPreferencesShippingFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingFilter"},"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"},"SimulationOrderOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderOrderLineItemsListFilter","type":"object","description":"SimulationOrderOrderLineItemsListFilter"},"SimulationOrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"SimulationOrderOrderLineItemsFilter","type":"object","description":"SimulationOrderOrderLineItemsFilter"},"SimulationOrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"SimulationOrderOrderLineItemsArticleFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleFilter"},"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"},"SimulationOrderPaymentInfoFilter":{"properties":{"methodLocalized":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderPaymentInfoMethodLocalizedFilter"}],"description":"Nested search by methodLocalized"},"currency":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by currency"},"method":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by method"}},"title":"SimulationOrderPaymentInfoFilter","type":"object","description":"SimulationOrderPaymentInfoFilter"},"SimulationOrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderPaymentInfoMethodLocalizedFilter","type":"object","description":"SimulationOrderPaymentInfoMethodLocalizedFilter"},"SimulationOrderTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderTagsListFilter","type":"object","description":"SimulationOrderTagsListFilter"},"SimulationOrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"SimulationOrderTagsFilter","type":"object","description":"SimulationOrderTagsFilter"},"SimulationOrderSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"}},"title":"SimulationOrderSort","type":"object","description":"SimulationOrderSort"}}}}
```

## The SimulationOrderSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/SimulationOrderSearchQuery"},"maxItems":500,"type":"array"},"consumer":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerFilter"}],"description":"Nested search by consumer"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"deliveryPreferences":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesFilter"}],"description":"Nested search by deliveryPreferences"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/SimulationOrderSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"orderLineItems":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsListFilter"}],"description":"Nested list search by orderLineItems"},"paymentInfo":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderPaymentInfoFilter"}],"description":"Nested search by paymentInfo"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"},"tags":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderTagsListFilter"}],"description":"Nested list search by tags"}},"title":"SimulationOrderSearchQuery","type":"object","description":"SimulationOrderSearchQuery"},"SimulationOrderConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"SimulationOrderConsumerFilter","type":"object","description":"SimulationOrderConsumerFilter"},"SimulationOrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderConsumerAddressesListFilter","type":"object","description":"SimulationOrderConsumerAddressesListFilter"},"SimulationOrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"SimulationOrderConsumerAddressesFilter","type":"object","description":"SimulationOrderConsumerAddressesFilter"},"SimulationOrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"SimulationOrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"SimulationOrderConsumerAddressesAddressTypeEnumFilter"},"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"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"SimulationOrderDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"}},"title":"SimulationOrderDeliveryPreferencesFilter","type":"object","description":"SimulationOrderDeliveryPreferencesFilter"},"SimulationOrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderDeliveryPreferencesCollectListFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectListFilter"},"SimulationOrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"SimulationOrderDeliveryPreferencesCollectFilter","type":"object","description":"SimulationOrderDeliveryPreferencesCollectFilter"},"SimulationOrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"SimulationOrderDeliveryPreferencesShippingFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingFilter"},"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter","type":"object","description":"SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter"},"SimulationOrderOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderOrderLineItemsListFilter","type":"object","description":"SimulationOrderOrderLineItemsListFilter"},"SimulationOrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"SimulationOrderOrderLineItemsFilter","type":"object","description":"SimulationOrderOrderLineItemsFilter"},"SimulationOrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"SimulationOrderOrderLineItemsArticleFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleFilter"},"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"SimulationOrderOrderLineItemsArticleTitleLocalizedFilter"},"SimulationOrderPaymentInfoFilter":{"properties":{"methodLocalized":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderPaymentInfoMethodLocalizedFilter"}],"description":"Nested search by methodLocalized"},"currency":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by currency"},"method":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by method"}},"title":"SimulationOrderPaymentInfoFilter","type":"object","description":"SimulationOrderPaymentInfoFilter"},"SimulationOrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"SimulationOrderPaymentInfoMethodLocalizedFilter","type":"object","description":"SimulationOrderPaymentInfoMethodLocalizedFilter"},"SimulationOrderTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderTagsListFilter","type":"object","description":"SimulationOrderTagsListFilter"},"SimulationOrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"SimulationOrderTagsFilter","type":"object","description":"SimulationOrderTagsFilter"}}}}
```

## The SimulationOrderSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"}},"title":"SimulationOrderSort","type":"object","description":"SimulationOrderSort"}}}}
```

## The SimulationOrderTagsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"SimulationOrderTagsFilter","type":"object","description":"SimulationOrderTagsFilter"},"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"}}}}
```

## The SimulationOrderTagsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SimulationOrderTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/SimulationOrderTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"SimulationOrderTagsListFilter","type":"object","description":"SimulationOrderTagsListFilter"},"SimulationOrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"SimulationOrderTagsFilter","type":"object","description":"SimulationOrderTagsFilter"},"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"}}}}
```

## The SortDirection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SortDirection":{"enum":["ASCENDING","DESCENDING"],"type":"string","title":"SortDirection","description":"SortDirection"}}}}
```

## The SortParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SortParameter":{"properties":{"sortDirection":{"$ref":"#/components/schemas/SortDirection"},"sortParameterName":{"$ref":"#/components/schemas/SortParameterName"}},"required":["sortDirection","sortParameterName"],"type":"object","title":"SortParameter","description":"SortParameter"},"SortDirection":{"enum":["ASCENDING","DESCENDING"],"type":"string","title":"SortDirection","description":"SortDirection"},"SortParameterName":{"enum":["NAME","ADDRESS","STATUS","OPERATIVESTATUS","SERVICETYPE","ORDEREDAMOUNT","ORDERDATE","ORDERID"],"type":"string","title":"SortParameterName","description":"SortParameterName"}}}}
```

## The SortParameterName object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SortParameterName":{"enum":["NAME","ADDRESS","STATUS","OPERATIVESTATUS","SERVICETYPE","ORDEREDAMOUNT","ORDERDATE","ORDERID"],"type":"string","title":"SortParameterName","description":"SortParameterName"}}}}
```

## The SourceRef object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"}}}}
```

## The SourcingOption object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOption":{"properties":{"estimatedDeliveryDate":{"description":"Estimated delivery date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"estimatedPickupDate":{"description":"Estimated pickup date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"id":{"type":"string"},"listingDetails":{"items":{"$ref":"#/components/schemas/SourcingOptionListingDetails"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/SourcingOptionNode"},"type":"array"},"nonAssignedOrderLineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"priorityRatingResults":{"items":{"$ref":"#/components/schemas/PriorityRatingResult"},"type":"array"},"ratingResults":{"items":{"$ref":"#/components/schemas/RatingResult"},"type":"array"},"runId":{"type":"string"},"totalCosts":{"$ref":"#/components/schemas/SourcingOptionCosts"},"totalPenalty":{"description":"The total calculated penalty we calculated for this option","type":"number"},"transfers":{"items":{"$ref":"#/components/schemas/SourcingOptionTransfer"},"type":"array"},"validUntil":{"description":"The latest date at which this option is still valid, as an ISO8601 UTC timestamp string.","type":"string"}},"required":["id","runId","totalPenalty","nodes","transfers","ratingResults","priorityRatingResults"],"type":"object","title":"SourcingOption","description":"SourcingOption"},"SourcingOptionListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"type":"object"},"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"}},"title":"SourcingOptionListingDetails","description":"SourcingOptionListingDetails"},"SourcingOptionNode":{"properties":{"facilityRef":{"type":"string"},"id":{"description":"id of this node, unique for this Sourcing Option Responses","type":"string"},"isPickUpLocation":{"description":"Indicates if this node is a pick up location","type":"boolean"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"tenantFacilityId":{"type":"string"},"type":{"$ref":"#/components/schemas/NodeType"}},"required":["id","type","lineItems"],"type":"object","title":"SourcingOptionNode","description":"SourcingOptionNode"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"},"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"},"PriorityRatingResult":{"properties":{"id":{"type":"string"},"matchesPriorityMinimum":{"type":"boolean"},"name":{"type":"string"},"routingStrategyNodeId":{"type":"string"},"type":{"$ref":"#/components/schemas/RatingResultType"}},"required":["id","type","routingStrategyNodeId","matchesPriorityMinimum"],"title":"PriorityRatingResult","description":"PriorityRatingResult"},"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"},"RatingResult":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"penalty":{"type":"number"},"routingStrategyNodeId":{"type":"string"},"type":{"description":"The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'","type":"string"}},"required":["penalty","id","type","routingStrategyNodeId","name"],"title":"RatingResult","description":"RatingResult"},"SourcingOptionCosts":{"additionalProperties":false,"properties":{"salesPrices":{"description":"Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.","items":{"$ref":"#/components/schemas/SourcingOptionSalesPrice"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money"},"totalSalesPriceAmount":{"$ref":"#/components/schemas/Money"},"totalShippingCosts":{"$ref":"#/components/schemas/ShippingCosts"}},"required":["salesPrices"],"type":"object","title":"SourcingOptionCosts","description":"SourcingOptionCosts"},"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"SourcingOptionTransfer":{"properties":{"carrier":{"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"}},"type":"object"},"costDetails":{"description":"The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"existenceReason":{"$ref":"#/components/schemas/SourcingOptionTransferExistenceReason"},"facilityConnectionRef":{"type":"string"},"fallbackCosts":{"$ref":"#/components/schemas/Money"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"packagingInformation":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingInformation"},"type":"array"},"sourceNodeRef":{"type":"string"},"strandId":{"type":"string"},"targetNodeRef":{"type":"string"},"timeLine":{"$ref":"#/components/schemas/TransferTimeLine"},"totalCosts":{"$ref":"#/components/schemas/Money"},"transferGroup":{"description":"The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.","type":"string"}},"required":["sourceNodeRef","targetNodeRef","lineItems","packagingInformation"],"type":"object","title":"SourcingOptionTransfer","description":"SourcingOptionTransfer"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"},"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"}}}}
```

## The SourcingOptionAnalyzeActionFacilityResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionAnalyzeActionFacilityResult":{"properties":{"analyzedConnections":{"allOf":[{"$ref":"#/components/schemas/ConnectionsAnalysisResult"}],"description":"Analysis of connections. Null when the facility is inside the resulting graph."},"fenceAnalysis":{"description":"List of fence analyses.","items":{"$ref":"#/components/schemas/FenceAnalysis"},"type":"array"},"listingAvailability":{"description":"List of listing availability analyses.","items":{"$ref":"#/components/schemas/ListingAvailabilityAnalysis"},"type":"array"},"lookupFacilityId":{"description":"The ID of the facility being looked up.","type":"string"}},"required":["lookupFacilityId","listingAvailability","fenceAnalysis"],"title":"SourcingOptionAnalyzeActionFacilityResult","type":"object","description":"SourcingOptionAnalyzeActionFacilityResult"},"ConnectionsAnalysisResult":{"properties":{"canBeIntermediateHop":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of connections from the graph to the lookup facility (layer 1 or 2)."},"canSupplyIntermediateHop":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of lookup facility as potential layer 0 (supplier)."},"canSupplyTarget":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of connections from the lookup facility to the target."}},"required":["canSupplyIntermediateHop","canBeIntermediateHop","canSupplyTarget"],"title":"ConnectionsAnalysisResult","type":"object","description":"ConnectionsAnalysisResult"},"ConnectionRefusedAnalysis":{"properties":{"containsInvalidContexts":{"description":"Indicates whether invalid contexts were found.","type":"boolean"},"containsInvalidTargets":{"description":"Indicates whether invalid targets were found.","type":"boolean"},"containsValidConnections":{"description":"Indicates whether valid connections exist.","type":"boolean"}},"required":["containsValidConnections","containsInvalidTargets","containsInvalidContexts"],"title":"ConnectionRefusedAnalysis","type":"object","description":"ConnectionRefusedAnalysis"},"FenceAnalysis":{"properties":{"fenceId":{"description":"The ID of the fence.","type":"string"},"fenceName":{"description":"The name of the fence.","type":"string"},"fenceType":{"description":"The type of fence.","enum":["STANDARD","TOOLKIT"],"type":"string"},"layer":{"description":"The layer at which the fence was evaluated.","type":"number"},"listingId":{"description":"The ID of the listing.","type":"string"},"nodeId":{"description":"The ID of the node.","type":"string"},"result":{"description":"The result of the fence evaluation.","enum":["PASSED","FAILED","NOT_APPLICABLE"],"type":"string"}},"required":["fenceType","nodeId","fenceId","result"],"title":"FenceAnalysis","type":"object","description":"FenceAnalysis"},"ListingAvailabilityAnalysis":{"properties":{"availableForPicking":{"description":"The quantity available for picking.","type":"number"},"facilityId":{"description":"The ID of the facility.","type":"string"},"outOfStockBehaviour":{"description":"The calculated out of stock behavior for the underlying order.","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"tenantArticleId":{"description":"The tenant article ID.","type":"string"}},"required":["facilityId","tenantArticleId","availableForPicking","outOfStockBehaviour"],"title":"ListingAvailabilityAnalysis","type":"object","description":"ListingAvailabilityAnalysis"}}}}
```

## The SourcingOptionAnalyzeActionResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionAnalyzeActionResult":{"properties":{"evaluationTimestamp":{"description":"The timestamp when the evaluation was performed.","format":"date-time","type":"string"},"orderId":{"description":"The ID of the order.","type":"string"},"reasons":{"description":"List of facility-level analysis results.","items":{"$ref":"#/components/schemas/SourcingOptionAnalyzeActionFacilityResult"},"type":"array"},"runId":{"description":"The runId of the sourcingOption analyses.","type":"string"}},"required":["orderId","evaluationTimestamp","runId","reasons"],"title":"SourcingOptionAnalyzeActionResult","type":"object","description":"SourcingOptionAnalyzeActionResult"},"SourcingOptionAnalyzeActionFacilityResult":{"properties":{"analyzedConnections":{"allOf":[{"$ref":"#/components/schemas/ConnectionsAnalysisResult"}],"description":"Analysis of connections. Null when the facility is inside the resulting graph."},"fenceAnalysis":{"description":"List of fence analyses.","items":{"$ref":"#/components/schemas/FenceAnalysis"},"type":"array"},"listingAvailability":{"description":"List of listing availability analyses.","items":{"$ref":"#/components/schemas/ListingAvailabilityAnalysis"},"type":"array"},"lookupFacilityId":{"description":"The ID of the facility being looked up.","type":"string"}},"required":["lookupFacilityId","listingAvailability","fenceAnalysis"],"title":"SourcingOptionAnalyzeActionFacilityResult","type":"object","description":"SourcingOptionAnalyzeActionFacilityResult"},"ConnectionsAnalysisResult":{"properties":{"canBeIntermediateHop":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of connections from the graph to the lookup facility (layer 1 or 2)."},"canSupplyIntermediateHop":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of lookup facility as potential layer 0 (supplier)."},"canSupplyTarget":{"allOf":[{"$ref":"#/components/schemas/ConnectionRefusedAnalysis"}],"description":"Analysis of connections from the lookup facility to the target."}},"required":["canSupplyIntermediateHop","canBeIntermediateHop","canSupplyTarget"],"title":"ConnectionsAnalysisResult","type":"object","description":"ConnectionsAnalysisResult"},"ConnectionRefusedAnalysis":{"properties":{"containsInvalidContexts":{"description":"Indicates whether invalid contexts were found.","type":"boolean"},"containsInvalidTargets":{"description":"Indicates whether invalid targets were found.","type":"boolean"},"containsValidConnections":{"description":"Indicates whether valid connections exist.","type":"boolean"}},"required":["containsValidConnections","containsInvalidTargets","containsInvalidContexts"],"title":"ConnectionRefusedAnalysis","type":"object","description":"ConnectionRefusedAnalysis"},"FenceAnalysis":{"properties":{"fenceId":{"description":"The ID of the fence.","type":"string"},"fenceName":{"description":"The name of the fence.","type":"string"},"fenceType":{"description":"The type of fence.","enum":["STANDARD","TOOLKIT"],"type":"string"},"layer":{"description":"The layer at which the fence was evaluated.","type":"number"},"listingId":{"description":"The ID of the listing.","type":"string"},"nodeId":{"description":"The ID of the node.","type":"string"},"result":{"description":"The result of the fence evaluation.","enum":["PASSED","FAILED","NOT_APPLICABLE"],"type":"string"}},"required":["fenceType","nodeId","fenceId","result"],"title":"FenceAnalysis","type":"object","description":"FenceAnalysis"},"ListingAvailabilityAnalysis":{"properties":{"availableForPicking":{"description":"The quantity available for picking.","type":"number"},"facilityId":{"description":"The ID of the facility.","type":"string"},"outOfStockBehaviour":{"description":"The calculated out of stock behavior for the underlying order.","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"tenantArticleId":{"description":"The tenant article ID.","type":"string"}},"required":["facilityId","tenantArticleId","availableForPicking","outOfStockBehaviour"],"title":"ListingAvailabilityAnalysis","type":"object","description":"ListingAvailabilityAnalysis"}}}}
```

## The SourcingOptionAnalyzeParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionAnalyzeParameter":{"properties":{"createdTime":{"description":"The creation time of the order for which the sourcing option analysis is performed.","format":"date-time","type":"string"},"facilityIds":{"description":"The list of facility IDs that receive a detailed analysis.","items":{"type":"string"},"type":"array"},"orderId":{"description":"The ID of the order for which the sourcing option analysis is performed.","type":"string"},"runId":{"description":"The run ID of the sourcing option request.","type":"string"},"sourcingOptionId":{"description":"The ID of the sourcing option to analyze.","type":"string"}},"required":["facilityIds"],"title":"SourcingOptionAnalyzeParameter","type":"object","description":"SourcingOptionAnalyzeParameter"}}}}
```

## The SourcingOptionCosts object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionCosts":{"additionalProperties":false,"properties":{"salesPrices":{"description":"Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.","items":{"$ref":"#/components/schemas/SourcingOptionSalesPrice"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money"},"totalSalesPriceAmount":{"$ref":"#/components/schemas/Money"},"totalShippingCosts":{"$ref":"#/components/schemas/ShippingCosts"}},"required":["salesPrices"],"type":"object","title":"SourcingOptionCosts","description":"SourcingOptionCosts"},"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"}}}}
```

## The SourcingOptionListingDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"type":"object"},"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"}},"title":"SourcingOptionListingDetails","description":"SourcingOptionListingDetails"}}}}
```

## The SourcingOptionNode object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionNode":{"properties":{"facilityRef":{"type":"string"},"id":{"description":"id of this node, unique for this Sourcing Option Responses","type":"string"},"isPickUpLocation":{"description":"Indicates if this node is a pick up location","type":"boolean"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"tenantFacilityId":{"type":"string"},"type":{"$ref":"#/components/schemas/NodeType"}},"required":["id","type","lineItems"],"type":"object","title":"SourcingOptionNode","description":"SourcingOptionNode"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"},"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"}}}}
```

## The SourcingOptionSalesPrice object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"}}}}
```

## The SourcingOptionsExecutionResults object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsExecutionResults":{"properties":{"totalRatingResults":{"items":{"$ref":"#/components/schemas/SourcingOptionTotalRatingResult"},"type":"array"}},"type":"object","title":"SourcingOptionsExecutionResults","description":"SourcingOptionsExecutionResults"},"SourcingOptionTotalRatingResult":{"properties":{"avgPenalty":{"type":"number"},"id":{"type":"string"},"maxPenalty":{"type":"number"},"minPenalty":{"type":"number"}},"required":["id","minPenalty","maxPenalty","avgPenalty"],"type":"object","title":"SourcingOptionTotalRatingResult","description":"SourcingOptionTotalRatingResult"}}}}
```

## The SourcingOptionsRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsRequest":{"properties":{"additionalInfo":{"$ref":"#/components/schemas/SourcingOptionsRequestAdditionalInfo"},"optimizationHints":{"$ref":"#/components/schemas/OptimizationHints"},"order":{"$ref":"#/components/schemas/OrderForSourcingOptionsRequest"},"resourceInvestment":{"$ref":"#/components/schemas/ResourceInvestment"}},"required":["order"],"type":"object","title":"SourcingOptionsRequest","description":"SourcingOptionsRequest"},"SourcingOptionsRequestAdditionalInfo":{"properties":{"includeListingCustomAttributes":{"default":false,"description":"If true, the listing custom attributes are included in the response. This is useful for debugging purposes.","type":"boolean"}},"type":"object","title":"SourcingOptionsRequestAdditionalInfo","description":"SourcingOptionsRequestAdditionalInfo"},"OptimizationHints":{"properties":{"includeCalculationHints":{"default":false,"description":"Should only be used for debugging. Includes more information on how we calculated the response.","type":"boolean"},"requestedResultCount":{"default":1,"description":"Number of different results we calculated","maximum":20,"type":"integer"}},"type":"object","title":"OptimizationHints","description":"OptimizationHints"},"OrderForSourcingOptionsRequest":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/ConsumerAddressesForSourcingOptions"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"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"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"minItems":1,"type":"array"}},"required":["consumer"],"type":"object","xml":{"name":"OrderForSourcingOptionsRequest"},"title":"OrderForSourcingOptionsRequest","description":"OrderForSourcingOptionsRequest"},"ConsumerAddressesForSourcingOptions":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddressForSourcingOptions"},"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"type":"object","title":"ConsumerAddressesForSourcingOptions","description":"ConsumerAddressesForSourcingOptions"},"ConsumerAddressForSourcingOptions":{"additionalProperties":false,"properties":{"additionalAddressInfo":{"type":"string"},"addressType":{"$ref":"#/components/schemas/AddressType"},"city":{"description":"The city of the address.","type":"string"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"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"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"houseNumber":{"pattern":"^.+$","type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/ConsumerAddressForSourcingOptionsPhoneNumber"},"type":"array"},"postalCode":{"description":"The postal code of the address.","type":"string"},"province":{"pattern":"^.+$","type":"string"},"salutation":{"type":"string"},"street":{"description":"The street of the address.","type":"string"}},"required":["country"],"title":"ConsumerAddressForSourcingOptions","description":"ConsumerAddressForSourcingOptions"},"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"},"ConsumerAddressForSourcingOptionsPhoneNumber":{"additionalProperties":false,"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","title":"ConsumerAddressForSourcingOptionsPhoneNumber","description":"ConsumerAddressForSourcingOptionsPhoneNumber"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"description":"Id of the SourcingOptions","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"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. Ensure that no authentication is needed 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"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"ResourceInvestment":{"description":"How much resources should be invested during the optimization?","properties":{"level":{"description":"[abstract values]: how many resources should we invest in optimization. With a higher level the results will be better, nevertheless we need to invest more time for the optimization.","exclusiveMinimum":true,"maximum":1,"minimum":0,"type":"number"}},"required":["level"],"type":"object","title":"ResourceInvestment"}}}}
```

## The SourcingOptionsRequestAdditionalInfo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsRequestAdditionalInfo":{"properties":{"includeListingCustomAttributes":{"default":false,"description":"If true, the listing custom attributes are included in the response. This is useful for debugging purposes.","type":"boolean"}},"type":"object","title":"SourcingOptionsRequestAdditionalInfo","description":"SourcingOptionsRequestAdditionalInfo"}}}}
```

## The SourcingOptionsResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsResponse":{"properties":{"id":{"description":"Id referring optimizations runId","type":"string"},"result":{"$ref":"#/components/schemas/SourcingOptionsResult"}},"required":["id","result"],"type":"object","title":"SourcingOptionsResponse","description":"SourcingOptionsResponse"},"SourcingOptionsResult":{"properties":{"options":{"items":{"$ref":"#/components/schemas/SourcingOption"},"type":"array"}},"required":["options"],"type":"object","title":"SourcingOptionsResult","description":"SourcingOptionsResult"},"SourcingOption":{"properties":{"estimatedDeliveryDate":{"description":"Estimated delivery date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"estimatedPickupDate":{"description":"Estimated pickup date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"id":{"type":"string"},"listingDetails":{"items":{"$ref":"#/components/schemas/SourcingOptionListingDetails"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/SourcingOptionNode"},"type":"array"},"nonAssignedOrderLineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"priorityRatingResults":{"items":{"$ref":"#/components/schemas/PriorityRatingResult"},"type":"array"},"ratingResults":{"items":{"$ref":"#/components/schemas/RatingResult"},"type":"array"},"runId":{"type":"string"},"totalCosts":{"$ref":"#/components/schemas/SourcingOptionCosts"},"totalPenalty":{"description":"The total calculated penalty we calculated for this option","type":"number"},"transfers":{"items":{"$ref":"#/components/schemas/SourcingOptionTransfer"},"type":"array"},"validUntil":{"description":"The latest date at which this option is still valid, as an ISO8601 UTC timestamp string.","type":"string"}},"required":["id","runId","totalPenalty","nodes","transfers","ratingResults","priorityRatingResults"],"type":"object","title":"SourcingOption","description":"SourcingOption"},"SourcingOptionListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"type":"object"},"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"}},"title":"SourcingOptionListingDetails","description":"SourcingOptionListingDetails"},"SourcingOptionNode":{"properties":{"facilityRef":{"type":"string"},"id":{"description":"id of this node, unique for this Sourcing Option Responses","type":"string"},"isPickUpLocation":{"description":"Indicates if this node is a pick up location","type":"boolean"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"tenantFacilityId":{"type":"string"},"type":{"$ref":"#/components/schemas/NodeType"}},"required":["id","type","lineItems"],"type":"object","title":"SourcingOptionNode","description":"SourcingOptionNode"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"},"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"},"PriorityRatingResult":{"properties":{"id":{"type":"string"},"matchesPriorityMinimum":{"type":"boolean"},"name":{"type":"string"},"routingStrategyNodeId":{"type":"string"},"type":{"$ref":"#/components/schemas/RatingResultType"}},"required":["id","type","routingStrategyNodeId","matchesPriorityMinimum"],"title":"PriorityRatingResult","description":"PriorityRatingResult"},"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"},"RatingResult":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"penalty":{"type":"number"},"routingStrategyNodeId":{"type":"string"},"type":{"description":"The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'","type":"string"}},"required":["penalty","id","type","routingStrategyNodeId","name"],"title":"RatingResult","description":"RatingResult"},"SourcingOptionCosts":{"additionalProperties":false,"properties":{"salesPrices":{"description":"Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.","items":{"$ref":"#/components/schemas/SourcingOptionSalesPrice"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money"},"totalSalesPriceAmount":{"$ref":"#/components/schemas/Money"},"totalShippingCosts":{"$ref":"#/components/schemas/ShippingCosts"}},"required":["salesPrices"],"type":"object","title":"SourcingOptionCosts","description":"SourcingOptionCosts"},"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"SourcingOptionTransfer":{"properties":{"carrier":{"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"}},"type":"object"},"costDetails":{"description":"The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"existenceReason":{"$ref":"#/components/schemas/SourcingOptionTransferExistenceReason"},"facilityConnectionRef":{"type":"string"},"fallbackCosts":{"$ref":"#/components/schemas/Money"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"packagingInformation":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingInformation"},"type":"array"},"sourceNodeRef":{"type":"string"},"strandId":{"type":"string"},"targetNodeRef":{"type":"string"},"timeLine":{"$ref":"#/components/schemas/TransferTimeLine"},"totalCosts":{"$ref":"#/components/schemas/Money"},"transferGroup":{"description":"The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.","type":"string"}},"required":["sourceNodeRef","targetNodeRef","lineItems","packagingInformation"],"type":"object","title":"SourcingOptionTransfer","description":"SourcingOptionTransfer"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"},"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"}}}}
```

## The SourcingOptionsResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsResult":{"properties":{"options":{"items":{"$ref":"#/components/schemas/SourcingOption"},"type":"array"}},"required":["options"],"type":"object","title":"SourcingOptionsResult","description":"SourcingOptionsResult"},"SourcingOption":{"properties":{"estimatedDeliveryDate":{"description":"Estimated delivery date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"estimatedPickupDate":{"description":"Estimated pickup date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"id":{"type":"string"},"listingDetails":{"items":{"$ref":"#/components/schemas/SourcingOptionListingDetails"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/SourcingOptionNode"},"type":"array"},"nonAssignedOrderLineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"priorityRatingResults":{"items":{"$ref":"#/components/schemas/PriorityRatingResult"},"type":"array"},"ratingResults":{"items":{"$ref":"#/components/schemas/RatingResult"},"type":"array"},"runId":{"type":"string"},"totalCosts":{"$ref":"#/components/schemas/SourcingOptionCosts"},"totalPenalty":{"description":"The total calculated penalty we calculated for this option","type":"number"},"transfers":{"items":{"$ref":"#/components/schemas/SourcingOptionTransfer"},"type":"array"},"validUntil":{"description":"The latest date at which this option is still valid, as an ISO8601 UTC timestamp string.","type":"string"}},"required":["id","runId","totalPenalty","nodes","transfers","ratingResults","priorityRatingResults"],"type":"object","title":"SourcingOption","description":"SourcingOption"},"SourcingOptionListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"type":"object"},"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"}},"title":"SourcingOptionListingDetails","description":"SourcingOptionListingDetails"},"SourcingOptionNode":{"properties":{"facilityRef":{"type":"string"},"id":{"description":"id of this node, unique for this Sourcing Option Responses","type":"string"},"isPickUpLocation":{"description":"Indicates if this node is a pick up location","type":"boolean"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"tenantFacilityId":{"type":"string"},"type":{"$ref":"#/components/schemas/NodeType"}},"required":["id","type","lineItems"],"type":"object","title":"SourcingOptionNode","description":"SourcingOptionNode"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"},"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"},"PriorityRatingResult":{"properties":{"id":{"type":"string"},"matchesPriorityMinimum":{"type":"boolean"},"name":{"type":"string"},"routingStrategyNodeId":{"type":"string"},"type":{"$ref":"#/components/schemas/RatingResultType"}},"required":["id","type","routingStrategyNodeId","matchesPriorityMinimum"],"title":"PriorityRatingResult","description":"PriorityRatingResult"},"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"},"RatingResult":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"penalty":{"type":"number"},"routingStrategyNodeId":{"type":"string"},"type":{"description":"The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'","type":"string"}},"required":["penalty","id","type","routingStrategyNodeId","name"],"title":"RatingResult","description":"RatingResult"},"SourcingOptionCosts":{"additionalProperties":false,"properties":{"salesPrices":{"description":"Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.","items":{"$ref":"#/components/schemas/SourcingOptionSalesPrice"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money"},"totalSalesPriceAmount":{"$ref":"#/components/schemas/Money"},"totalShippingCosts":{"$ref":"#/components/schemas/ShippingCosts"}},"required":["salesPrices"],"type":"object","title":"SourcingOptionCosts","description":"SourcingOptionCosts"},"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"SourcingOptionTransfer":{"properties":{"carrier":{"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"}},"type":"object"},"costDetails":{"description":"The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"existenceReason":{"$ref":"#/components/schemas/SourcingOptionTransferExistenceReason"},"facilityConnectionRef":{"type":"string"},"fallbackCosts":{"$ref":"#/components/schemas/Money"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"packagingInformation":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingInformation"},"type":"array"},"sourceNodeRef":{"type":"string"},"strandId":{"type":"string"},"targetNodeRef":{"type":"string"},"timeLine":{"$ref":"#/components/schemas/TransferTimeLine"},"totalCosts":{"$ref":"#/components/schemas/Money"},"transferGroup":{"description":"The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.","type":"string"}},"required":["sourceNodeRef","targetNodeRef","lineItems","packagingInformation"],"type":"object","title":"SourcingOptionTransfer","description":"SourcingOptionTransfer"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"},"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"}}}}
```

## The SourcingOptionsTransferDeliverCostCoefficient object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"}}}}
```

## The SourcingOptionsTransferDeliveryCost object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"}}}}
```

## The SourcingOptionsTransferPackagingInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"}}}}
```

## The SourcingOptionsTransferPackagingUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"}}}}
```

## The SourcingOptionsTransferPackagingUnitDimensions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"}}}}
```

## The SourcingOptionsTransferTransitTime object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"}}}}
```

## The SourcingOptionTotalRatingResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionTotalRatingResult":{"properties":{"avgPenalty":{"type":"number"},"id":{"type":"string"},"maxPenalty":{"type":"number"},"minPenalty":{"type":"number"}},"required":["id","minPenalty","maxPenalty","avgPenalty"],"type":"object","title":"SourcingOptionTotalRatingResult","description":"SourcingOptionTotalRatingResult"}}}}
```

## The SourcingOptionTransfer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionTransfer":{"properties":{"carrier":{"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"}},"type":"object"},"costDetails":{"description":"The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"existenceReason":{"$ref":"#/components/schemas/SourcingOptionTransferExistenceReason"},"facilityConnectionRef":{"type":"string"},"fallbackCosts":{"$ref":"#/components/schemas/Money"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"packagingInformation":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingInformation"},"type":"array"},"sourceNodeRef":{"type":"string"},"strandId":{"type":"string"},"targetNodeRef":{"type":"string"},"timeLine":{"$ref":"#/components/schemas/TransferTimeLine"},"totalCosts":{"$ref":"#/components/schemas/Money"},"transferGroup":{"description":"The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.","type":"string"}},"required":["sourceNodeRef","targetNodeRef","lineItems","packagingInformation"],"type":"object","title":"SourcingOptionTransfer","description":"SourcingOptionTransfer"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId"],"type":"object","title":"HandledItem","description":"HandledItem"},"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"}}}}
```

## The SourcingOptionTransferExistenceReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"}}}}
```

## The SplitInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SplitInformation":{"properties":{"splitCount":{"type":"number"},"splittedItems":{"items":{"$ref":"#/components/schemas/AssignmentItem"},"type":"array"},"targetFacility":{"$ref":"#/components/schemas/DecisionLogFacilityInfo"},"targetRoutingPlanRef":{"type":"string"}},"required":["splitCount","targetRoutingPlanRef","splittedItems"],"title":"SplitInformation","description":"SplitInformation"},"AssignmentItem":{"properties":{"articleTitle":{"type":"string"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"AssignmentItem","description":"AssignmentItem"},"DecisionLogFacilityInfo":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"}},"required":["name","facilityRef"],"title":"DecisionLogFacilityInfo","description":"DecisionLogFacilityInfo"}}}}
```

## The SplitResultType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SplitResultType":{"enum":["SPLIT","DO_NOT_SPLIT","DO_NOT_SPLIT_USE_BEST_RATED","DO_NOT_SPLIT_BECAUSE_AVAILABILITY_USE_BEST_RATED","DO_NOT_SPLIT_USE_BEST_AVAILABLE","REASSIGN_TO_PARENT","REASSIGN_TO_PARENT_COMPLETELY","FAIL","INVALID_SPLIT","PARK_IN_WAITING_ROOM"],"title":"SplitResultType","description":"SplitResultType"}}}}
```

## The Stack object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Stack":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"facilityRefs":{"description":"Linked Facilities through reference","items":{"type":"string"},"maxItems":50,"type":"array"},"id":{"description":"Unique identifier of the Stack","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"processRefs":{"description":"Linked Processes through reference","items":{"type":"string"},"maxItems":50,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","facilityRefs","processRefs"],"title":"Stack","type":"object","description":"Stack"}}}}
```

## The StackForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StackForCreation":{"properties":{"facilityRefs":{"description":"Linked Facilities through reference","items":{"type":"string"},"maxItems":50,"type":"array"},"processRefs":{"description":"Linked Processes through reference","items":{"type":"string"},"maxItems":50,"type":"array"}},"required":["facilityRefs","processRefs"],"title":"StackForCreation","type":"object","description":"StackForCreation"}}}}
```

## The StackResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StackResponse":{"properties":{"stacks":{"description":"Array of Stacks matching the given filter","items":{"$ref":"#/components/schemas/Stack"},"type":"array"},"total":{"description":"Total number of stacks for the given filter","format":"int64","type":"integer"}},"required":["stacks","total"],"title":"StackResponse","type":"object","description":"StackResponse"},"Stack":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"facilityRefs":{"description":"Linked Facilities through reference","items":{"type":"string"},"maxItems":50,"type":"array"},"id":{"description":"Unique identifier of the Stack","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"processRefs":{"description":"Linked Processes through reference","items":{"type":"string"},"maxItems":50,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","facilityRefs","processRefs"],"title":"Stack","type":"object","description":"Stack"}}}}
```

## The StartItemReturnActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StartItemReturnActionParameter":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"enum":["StartItemReturn"],"type":"string"}},"required":["name","itemReturnJobVersion"],"title":"StartItemReturnActionParameter","type":"object","description":"StartItemReturnActionParameter"}}}}
```

## The StartItemReturnJobActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StartItemReturnJobActionParameter":{"properties":{"name":{"enum":["StartItemReturnJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","name"],"title":"StartItemReturnJobActionParameter","type":"object","description":"StartItemReturnJobActionParameter"}}}}
```

## The StartPickRun object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StartPickRun":{"allOf":[{"additionalProperties":false,"properties":{"action":{"description":"Use value 'StartPickRun', because you want to start a pickrun","enum":["StartPickRun"],"type":"string"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Use api/pickruns/:id/actions instead","title":"StartPickRun","xml":{"name":"StartPickRun"}}}}}
```

## The StartStowJobAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StartStowJobAction":{"description":"Sets the status of the stowjob to IN_PROGRESS","properties":{"name":{"description":"The name of the action that should be performed","enum":["START_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"StartStowJobAction","type":"object"}}}}
```

## The Status object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Status":{"additionalProperties":false,"properties":{"status":{"description":"The current state of the API","enum":["UP","DEGRADED","DOWN"],"type":"string"}},"required":["status"],"type":"object","xml":{"name":"Status"},"title":"Status","description":"Status"}}}}
```

## The StatusReason object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The StatusReasonsPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StatusReasonsPayload":{"properties":{"statusReason":{"allOf":[{"$ref":"#/components/schemas/OrderStatusReasonLog"}],"description":"Reason for the status change","type":"object"}},"type":"object","title":"StatusReasonsPayload","description":"StatusReasonsPayload"},"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"}}}}
```

## The Sticker object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The StickerConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The Stock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockAction":{"properties":{"action":{"description":"Action to be performed on the stock. If a user has specific facility context limitations, only stocks located in the referenced facilities will be affected","discriminator":{"propertyName":"name"},"oneOf":[{"$ref":"#/components/schemas/StockDeleteByLocations"},{"$ref":"#/components/schemas/StockDeleteByProducts"},{"$ref":"#/components/schemas/StockDeleteByIds"},{"$ref":"#/components/schemas/StockMoveToLocation"},{"$ref":"#/components/schemas/VersionlessUpdateStock"}]},"actions":{"deprecated":true,"description":"Deprecated. Use 'action' with a single action input instead.","items":{"oneOf":[{"$ref":"#/components/schemas/StockDeleteByLocations"},{"$ref":"#/components/schemas/StockDeleteByProducts"},{"$ref":"#/components/schemas/StockDeleteByIds"}]},"maxItems":10,"type":"array"}},"title":"StockAction","type":"object","description":"StockAction"},"StockDeleteByLocations":{"properties":{"locationRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"name":{"enum":["DELETE_BY_LOCATIONS"],"type":"string"}},"required":["name","locationRefs"],"title":"StockDeleteByLocations","type":"object","description":"StockDeleteByLocations"},"StockDeleteByProducts":{"properties":{"facilityRef":{"type":"string"},"name":{"enum":["DELETE_BY_PRODUCTS"],"type":"string"},"tenantArticleIds":{"items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["name","facilityRef","tenantArticleIds"],"title":"StockDeleteByProducts","type":"object","description":"StockDeleteByProducts"},"StockDeleteByIds":{"properties":{"ids":{"items":{"type":"string"},"maxItems":500,"type":"array"},"name":{"enum":["DELETE_BY_IDS"],"type":"string"}},"required":["name","ids"],"title":"StockDeleteByIds","type":"object","description":"StockDeleteByIds"},"StockMoveToLocation":{"properties":{"amount":{"type":"number"},"fromStockId":{"type":"string"},"name":{"enum":["MOVE_TO_LOCATION"],"type":"string"},"options":{"$ref":"#/components/schemas/MoveStockToLocationOptions"},"toLocationRef":{"type":"string"}},"required":["name","fromStockId","toLocationRef","amount"],"title":"StockMoveToLocation","type":"object","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />StockMoveToLocation"},"MoveStockToLocationOptions":{"properties":{"deleteFromStockIfZero":{"type":"boolean"}},"title":"MoveStockToLocationOptions","type":"object","description":"MoveStockToLocationOptions"},"VersionlessUpdateStock":{"properties":{"name":{"enum":["UPDATE_VERSIONLESS"],"type":"string"},"stocks":{"description":"Please be sure to include each stock (by ID) only once, when updating. Otherwise the whole batch is rejected with an error.","items":{"discriminator":{"propertyName":"operationType"},"oneOf":[{"$ref":"#/components/schemas/StockForCreationVersionless"},{"$ref":"#/components/schemas/StockForUpdateVersionless"}]},"maxItems":25,"type":"array"}},"required":["name","stocks"],"title":"VersionlessUpdateStock","type":"object","description":"VersionlessUpdateStock"},"StockForCreationVersionless":{"properties":{"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"facilityRef":{"deprecated":true,"description":"facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"operationType":{"enum":["CREATE"],"type":"string"},"properties":{"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"},{"additionalProperties":{"type":"string"},"type":"object"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantFacilityId":{"deprecated":true,"description":"tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["tenantArticleId","value","operationType"],"title":"StockForCreationVersionless","type":"object","description":"StockForCreationVersionless"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"StockForUpdateVersionless":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"operationType":{"enum":["UPDATE"],"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["value","id","operationType"],"title":"StockForUpdateVersionless","type":"object","description":"StockForUpdateVersionless"}}}}
```

## The StockActionResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockActionResult":{"properties":{"name":{"enum":["DELETE_BY_LOCATIONS","DELETE_BY_PRODUCTS","DELETE_BY_IDS","MOVE_TO_LOCATION","UPDATE_VERSIONLESS"],"type":"string"},"result":{"oneOf":[{"$ref":"#/components/schemas/StockDeleteActionResult"},{"$ref":"#/components/schemas/StockMoveToLocationActionResult"},{"$ref":"#/components/schemas/StockVersionlessUpsertActionResult"}]}},"required":["name","result"],"title":"StockActionResult","type":"object","description":"StockActionResult"},"StockDeleteActionResult":{"properties":{"ids":{"items":{"type":"string"},"type":"array"}},"required":["ids"],"title":"StockDeleteActionResult","type":"object","description":"StockDeleteActionResult"},"StockMoveToLocationActionResult":{"properties":{"fromStock":{"$ref":"#/components/schemas/Stock"},"toStock":{"$ref":"#/components/schemas/Stock"}},"required":["toStock"],"title":"StockMoveToLocationActionResult","type":"object","description":"StockMoveToLocationActionResult"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"StockVersionlessUpsertActionResult":{"properties":{"operationResults":{"$ref":"#/components/schemas/StockUpsertOperationResult"}},"required":["operationResults"],"title":"StockVersionlessUpsertActionResult","type":"object","description":"StockVersionlessUpsertActionResult"},"StockUpsertOperationResult":{"properties":{"status":{"enum":["UPDATED","CREATED","UNCHANGED"],"type":"string"},"stock":{"$ref":"#/components/schemas/Stock"}},"required":["stock","status"],"title":"StockUpsertOperationResult","type":"object","description":"StockUpsertOperationResult"}}}}
```

## The StockConditionEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockConditionEnumFilter":{"properties":{"eq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"},"in":{"description":"Search by conditions","items":{"enum":["DEFECTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"}},"title":"StockConditionEnumFilter","type":"object","description":"StockConditionEnumFilter"}}}}
```

## The StockConditionEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockConditionEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumFilter"}],"description":"Search by conditions"}},"title":"StockConditionEnumListFilter","type":"object","description":"StockConditionEnumListFilter"},"StockConditionEnumFilter":{"properties":{"eq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"},"in":{"description":"Search by conditions","items":{"enum":["DEFECTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"}},"title":"StockConditionEnumFilter","type":"object","description":"StockConditionEnumFilter"}}}}
```

## The StockConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockConfiguration":{"allOf":[{"$ref":"#/components/schemas/StockConfigurationForUpdate"},{"$ref":"#/components/schemas/VersionedResource"}],"description":"https://docs.fulfillmenttools.com/documentation/products/inventory-management/configurations","properties":{"id":{"type":"string"}},"type":"object","xml":{"name":"StockConfiguration"},"title":"StockConfiguration"},"StockConfigurationForUpdate":{"allOf":[{"$ref":"#/components/schemas/StockConfigurationForCreation"}],"description":"Stock configuration data for updates","properties":{"version":{"description":"Version of the documentSet you want to update a document of","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"StockConfigurationForUpdate"},"StockConfigurationForCreation":{"description":"Stock configuration data for creation","properties":{"expectedStock":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration for expected stock generation from routing plans","properties":{"generateFromRoutingPlan":{"default":false,"description":"If true, automatically create incoming expected stock after routing","type":"boolean"}},"type":"object"},"inboundProcess":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration for inbound process creation from interfacility transfers","properties":{"generateFromInterfacilityTransfer":{"default":true,"description":"If true, automatically create an internal purchase order when an interfacility transfer is handed over. Defaults to true.","type":"boolean"}},"type":"object"},"reservedStock":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This config has no effect yet","properties":{"clearAllPredecessors":{"deprecated":true,"description":"@deprecated Clear stocks and reservations in supplying facilities when handover events occur in the receiving facility","type":"boolean"},"clearStocksAndReservationsTrigger":{"description":"Clear related stocks and reservations when the specified events occur","items":{"properties":{"completionEntity":{"$ref":"#/components/schemas/ReservationReleaseCompletionEntityEnum"}},"required":["completionEntity"],"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"stockModificationEnabled":{"default":true,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Indicates if manual stock modification is allowed - will be moved to remoteConfig","type":"boolean"}},"required":["stockModificationEnabled"],"type":"object","title":"StockConfigurationForCreation"},"ReservationReleaseCompletionEntityEnum":{"enum":["HANDOVERJOB","PICKJOB"],"type":"string","title":"ReservationReleaseCompletionEntityEnum","description":"ReservationReleaseCompletionEntityEnum"},"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"}}}}
```

## The StockConfigurationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockConfigurationForCreation":{"description":"Stock configuration data for creation","properties":{"expectedStock":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration for expected stock generation from routing plans","properties":{"generateFromRoutingPlan":{"default":false,"description":"If true, automatically create incoming expected stock after routing","type":"boolean"}},"type":"object"},"inboundProcess":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration for inbound process creation from interfacility transfers","properties":{"generateFromInterfacilityTransfer":{"default":true,"description":"If true, automatically create an internal purchase order when an interfacility transfer is handed over. Defaults to true.","type":"boolean"}},"type":"object"},"reservedStock":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This config has no effect yet","properties":{"clearAllPredecessors":{"deprecated":true,"description":"@deprecated Clear stocks and reservations in supplying facilities when handover events occur in the receiving facility","type":"boolean"},"clearStocksAndReservationsTrigger":{"description":"Clear related stocks and reservations when the specified events occur","items":{"properties":{"completionEntity":{"$ref":"#/components/schemas/ReservationReleaseCompletionEntityEnum"}},"required":["completionEntity"],"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"stockModificationEnabled":{"default":true,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Indicates if manual stock modification is allowed - will be moved to remoteConfig","type":"boolean"}},"required":["stockModificationEnabled"],"type":"object","title":"StockConfigurationForCreation"},"ReservationReleaseCompletionEntityEnum":{"enum":["HANDOVERJOB","PICKJOB"],"type":"string","title":"ReservationReleaseCompletionEntityEnum","description":"ReservationReleaseCompletionEntityEnum"}}}}
```

## The StockConfigurationForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockConfigurationForUpdate":{"allOf":[{"$ref":"#/components/schemas/StockConfigurationForCreation"}],"description":"Stock configuration data for updates","properties":{"version":{"description":"Version of the documentSet you want to update a document of","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"StockConfigurationForUpdate"},"StockConfigurationForCreation":{"description":"Stock configuration data for creation","properties":{"expectedStock":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration for expected stock generation from routing plans","properties":{"generateFromRoutingPlan":{"default":false,"description":"If true, automatically create incoming expected stock after routing","type":"boolean"}},"type":"object"},"inboundProcess":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Configuration for inbound process creation from interfacility transfers","properties":{"generateFromInterfacilityTransfer":{"default":true,"description":"If true, automatically create an internal purchase order when an interfacility transfer is handed over. Defaults to true.","type":"boolean"}},"type":"object"},"reservedStock":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This config has no effect yet","properties":{"clearAllPredecessors":{"deprecated":true,"description":"@deprecated Clear stocks and reservations in supplying facilities when handover events occur in the receiving facility","type":"boolean"},"clearStocksAndReservationsTrigger":{"description":"Clear related stocks and reservations when the specified events occur","items":{"properties":{"completionEntity":{"$ref":"#/components/schemas/ReservationReleaseCompletionEntityEnum"}},"required":["completionEntity"],"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"stockModificationEnabled":{"default":true,"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Indicates if manual stock modification is allowed - will be moved to remoteConfig","type":"boolean"}},"required":["stockModificationEnabled"],"type":"object","title":"StockConfigurationForCreation"},"ReservationReleaseCompletionEntityEnum":{"enum":["HANDOVERJOB","PICKJOB"],"type":"string","title":"ReservationReleaseCompletionEntityEnum","description":"ReservationReleaseCompletionEntityEnum"}}}}
```

## The StockConfigurationPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockConfigurationPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyRetainedOfflineStock"},{"$ref":"#/components/schemas/ModifyListingReactivationAfter"},{"$ref":"#/components/schemas/ModifyShortpick"}]},"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":"FacilityPatchActions"},"title":"StockConfigurationPatchActions","description":"StockConfigurationPatchActions"},"ModifyRetainedOfflineStock":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Concept depreated. Use safety stock instead.","enum":["ModifyRetainedOfflineStock"],"type":"string"},"active":{"description":"The retained Offline Stock is enabled or disabled.","type":"boolean"},"value":{"default":0.2,"description":"The overall percentage of stock that should be reserved to offline clients.","maximum":1,"minimum":0.01,"type":"number"}},"required":["action"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated Concept depreated. Use safety stock instead.","title":"ModifyRetainedOfflineStockAction","xml":{"name":"ModifyRetainedOfflineStock"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"ModifyListingReactivationAfter":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyListingReactivationAfter', if you want to modify the listingReactivationAfter of a facility","enum":["ModifyListingReactivationAfter"],"type":"string"},"listingReactivationAfter":{"properties":{"active":{"default":true,"description":"The disabling of listings is enabled or disabled.","type":"boolean"},"value":{"default":24,"description":"Time in hours that has to pass for a deactivated listing (e.g. due to manual deactivation or as a result of a shortpick ) to be become active again.","type":"number"}},"type":"object"}},"required":["action"],"type":"object"}],"description":"Action to modify the reactivationAfter property of a Listing.","title":"ModifyListingReactivationAfterAction","xml":{"name":"ModifyListingReactivationAfter"}},"ModifyShortpick":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"properties":{"action":{"description":"Use value 'ModifyShortpick', if you want to modify the ModifyShortPick of a facility","enum":["ModifyShortpick"],"type":"string"},"active":{"default":true,"description":"Inventory adjustment in the case of insufficient order picking","type":"boolean"}},"required":["action"],"type":"object"}],"description":"Modify Shortpick Action.","title":"ModifyShortpick","xml":{"name":"ModifyShortpick"}}}}}
```

## The StockDeleteActionResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockDeleteActionResult":{"properties":{"ids":{"items":{"type":"string"},"type":"array"}},"required":["ids"],"title":"StockDeleteActionResult","type":"object","description":"StockDeleteActionResult"}}}}
```

## The StockDeleteByIds object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockDeleteByIds":{"properties":{"ids":{"items":{"type":"string"},"maxItems":500,"type":"array"},"name":{"enum":["DELETE_BY_IDS"],"type":"string"}},"required":["name","ids"],"title":"StockDeleteByIds","type":"object","description":"StockDeleteByIds"}}}}
```

## The StockDeleteByLocations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockDeleteByLocations":{"properties":{"locationRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"name":{"enum":["DELETE_BY_LOCATIONS"],"type":"string"}},"required":["name","locationRefs"],"title":"StockDeleteByLocations","type":"object","description":"StockDeleteByLocations"}}}}
```

## The StockDeleteByProducts object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockDeleteByProducts":{"properties":{"facilityRef":{"type":"string"},"name":{"enum":["DELETE_BY_PRODUCTS"],"type":"string"},"tenantArticleIds":{"items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["name","facilityRef","tenantArticleIds"],"title":"StockDeleteByProducts","type":"object","description":"StockDeleteByProducts"}}}}
```

## The StockDistribution object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockDistribution":{"properties":{"facilityStocks":{"items":{"$ref":"#/components/schemas/FacilityStockDistribution"},"type":"array"},"summary":{"$ref":"#/components/schemas/StockSummaryDetails"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","summary","facilityStocks"],"title":"StockDistribution","type":"object","description":"StockDistribution"},"FacilityStockDistribution":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","minimum":0,"type":"number"},"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/ByTrait"},"channelAdjusted":{"items":{"$ref":"#/components/schemas/ChannelStockAvailability"},"type":"array"},"facilityId":{"type":"string"},"facilityName":{"type":"string"},"facilityServiceTypes":{"items":{"$ref":"#/components/schemas/FacilityServiceType"},"type":"array"},"facilityStatus":{"$ref":"#/components/schemas/FacilityStatus"},"price":{"deprecated":true,"description":"Use listings attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","nullable":true,"type":"number"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"minimum":0,"type":"number"},"safetyStock":{"minimum":0,"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"minimum":0,"type":"number"}},"required":["reserved","totalAmount","available","safetyStock","byTrait","availableForPicking","availableToPromise","readyToPick","availableOnStock","stockOnHand","facilityId","facilityName"],"title":"FacilityStockDistribution","type":"object","description":"FacilityStockDistribution"},"ByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"ByTrait","type":"object","description":"ByTrait"},"ChannelStockAvailability":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"channelRef":{"type":"string"}},"required":["channelRef","availableForPicking","availableOnStock"],"title":"ChannelStockAvailability","type":"object","description":"ChannelStockAvailability"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"StockSummaryDetails":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","minimum":0,"type":"number"},"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/ByTrait"},"channelAdjusted":{"items":{"$ref":"#/components/schemas/ChannelStockAvailability"},"type":"array"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"minimum":0,"type":"number"},"safetyStock":{"minimum":0,"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"minimum":0,"type":"number"}},"required":["reserved","totalAmount","available","safetyStock","byTrait","availableForPicking","availableToPromise","readyToPick","availableOnStock","stockOnHand"],"title":"StockSummaryDetails","type":"object","description":"StockSummaryDetails"}}}}
```

## The StockFacilityReferences object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"}}}}
```

## The StockForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockForCreation":{"properties":{"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"facilityRef":{"deprecated":true,"description":"facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"},{"additionalProperties":{"type":"string"},"type":"object"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantFacilityId":{"deprecated":true,"description":"tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["tenantArticleId","value"],"title":"StockForCreation","type":"object","description":"StockForCreation"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockForCreationVersionless object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockForCreationVersionless":{"properties":{"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"facilityRef":{"deprecated":true,"description":"facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"operationType":{"enum":["CREATE"],"type":"string"},"properties":{"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"},{"additionalProperties":{"type":"string"},"type":"object"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantFacilityId":{"deprecated":true,"description":"tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["tenantArticleId","value","operationType"],"title":"StockForCreationVersionless","type":"object","description":"StockForCreationVersionless"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockForUpdate":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"locationRef":{"nullable":true,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["value","version"],"title":"StockForUpdate","type":"object","description":"StockForUpdate"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockForUpdateVersionless object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockForUpdateVersionless":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"operationType":{"enum":["UPDATE"],"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["value","id","operationType"],"title":"StockForUpdateVersionless","type":"object","description":"StockForUpdateVersionless"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockForUpsertUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockForUpsertUpdate":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["value","id","version"],"title":"StockForUpsertUpdate","type":"object","description":"StockForUpsertUpdate"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"}}}}
```

## The StockInformationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"}}}}
```

## The StockMoveToLocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockMoveToLocation":{"properties":{"amount":{"type":"number"},"fromStockId":{"type":"string"},"name":{"enum":["MOVE_TO_LOCATION"],"type":"string"},"options":{"$ref":"#/components/schemas/MoveStockToLocationOptions"},"toLocationRef":{"type":"string"}},"required":["name","fromStockId","toLocationRef","amount"],"title":"StockMoveToLocation","type":"object","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />StockMoveToLocation"},"MoveStockToLocationOptions":{"properties":{"deleteFromStockIfZero":{"type":"boolean"}},"title":"MoveStockToLocationOptions","type":"object","description":"MoveStockToLocationOptions"}}}}
```

## The StockMoveToLocationActionResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockMoveToLocationActionResult":{"properties":{"fromStock":{"$ref":"#/components/schemas/Stock"},"toStock":{"$ref":"#/components/schemas/Stock"}},"required":["toStock"],"title":"StockMoveToLocationActionResult","type":"object","description":"StockMoveToLocationActionResult"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"stocks":{"items":{"$ref":"#/components/schemas/Stock"},"type":"array"},"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","stocks"],"title":"StockPaginatedResult","type":"object","description":"StockPaginatedResult"},"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"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockPropertyDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"}}}}
```

## The StockPropertyInputType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"}}}}
```

## The StockPropertyPreset object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## The StockSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockSearchPayload":{"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/StockSearchQuery"},"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/StockSort"},"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":"StockSearchPayload","type":"object","description":"StockSearchPayload"},"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"},"StockSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/StockSearchQuery"},"maxItems":500,"type":"array"},"availableUntil":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by availableUntil"},"conditions":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumListFilter"}],"description":"Search by conditions"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"locationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by locationRef"},"or":{"items":{"$ref":"#/components/schemas/StockSearchQuery"},"maxItems":500,"type":"array"},"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/DateFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by properties","type":"object"},"receiptDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receiptDate"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"tenantFacilityId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"tenantFacilityId is handled like facilityRef filter, if you want to search by both you should wrap that filter in an \"or\" filter"},"tenantStockId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantStockId"},"traits":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumListFilter"}],"description":"Search by traits"},"value":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by value"}},"title":"StockSearchQuery","type":"object","description":"StockSearchQuery"},"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"},"StockConditionEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumFilter"}],"description":"Search by conditions"}},"title":"StockConditionEnumListFilter","type":"object","description":"StockConditionEnumListFilter"},"StockConditionEnumFilter":{"properties":{"eq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"},"in":{"description":"Search by conditions","items":{"enum":["DEFECTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"}},"title":"StockConditionEnumFilter","type":"object","description":"StockConditionEnumFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StockStorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StockStorageLocationTraitEnumListFilter","type":"object","description":"StockStorageLocationTraitEnumListFilter"},"StockStorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StockStorageLocationTraitEnumFilter","type":"object","description":"StockStorageLocationTraitEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StockSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"locationName":{"enum":["ASC","DESC"],"type":"string"},"tenantArticleId":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"StockSort","type":"object","description":"StockSort"}}}}
```

## The StockSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/StockSearchQuery"},"maxItems":500,"type":"array"},"availableUntil":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by availableUntil"},"conditions":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumListFilter"}],"description":"Search by conditions"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"locationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by locationRef"},"or":{"items":{"$ref":"#/components/schemas/StockSearchQuery"},"maxItems":500,"type":"array"},"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/DateFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by properties","type":"object"},"receiptDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receiptDate"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"tenantFacilityId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"tenantFacilityId is handled like facilityRef filter, if you want to search by both you should wrap that filter in an \"or\" filter"},"tenantStockId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantStockId"},"traits":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumListFilter"}],"description":"Search by traits"},"value":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by value"}},"title":"StockSearchQuery","type":"object","description":"StockSearchQuery"},"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"},"StockConditionEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumFilter"}],"description":"Search by conditions"}},"title":"StockConditionEnumListFilter","type":"object","description":"StockConditionEnumListFilter"},"StockConditionEnumFilter":{"properties":{"eq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"},"in":{"description":"Search by conditions","items":{"enum":["DEFECTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"}},"title":"StockConditionEnumFilter","type":"object","description":"StockConditionEnumFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StockStorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StockStorageLocationTraitEnumListFilter","type":"object","description":"StockStorageLocationTraitEnumListFilter"},"StockStorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StockStorageLocationTraitEnumFilter","type":"object","description":"StockStorageLocationTraitEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"}}}}
```

## The StockSelectionSection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockSelectionSection":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/PickingOutcomeDiagnostic"},"type":"array"}},"required":["diagnostics"],"title":"StockSelectionSection","type":"object","description":"StockSelectionSection"},"PickingOutcomeDiagnostic":{"properties":{"code":{"$ref":"#/components/schemas/DiagnosticCode"}},"required":["code"],"title":"PickingOutcomeDiagnostic","type":"object","description":"PickingOutcomeDiagnostic"},"DiagnosticCode":{"description":"Indicates the specific reason a picking diagnostic was raised.\n\nSTOCK_SHORT_PICK => The quantity picked from a partial stock location was below the requested quantity, while short-pick handling was enabled for this configuration.\n\nLINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was below the requested quantity.\n\nSTOCK_NOT_FOUND => The specified stock reference or tenant stock ID could not be found.\n\nINSUFFICIENT_STOCK => The target stock did not have enough available quantity to fulfill the request.","enum":["STOCK_SHORT_PICK","LINE_ITEM_SHORT_PICK","STOCK_NOT_FOUND","INSUFFICIENT_STOCK"],"type":"string","xml":{"name":"DiagnosticCode"},"title":"DiagnosticCode"}}}}
```

## The StocksForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StocksForUpsert":{"properties":{"stocks":{"description":"Please be sure to include each stock (by ID) only once, when updating. Otherwise the whole batch is rejected with an error.","items":{"oneOf":[{"$ref":"#/components/schemas/StockForCreation"},{"$ref":"#/components/schemas/StockForUpsertUpdate"},{"not":{"required":["version"]},"properties":{"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["id","value"],"type":"object"}]},"maxItems":500,"type":"array"}},"required":["stocks"],"title":"StocksForUpsert","type":"object","description":"StocksForUpsert"},"StockForCreation":{"properties":{"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"facilityRef":{"deprecated":true,"description":"facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"},{"additionalProperties":{"type":"string"},"type":"object"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantFacilityId":{"deprecated":true,"description":"tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["tenantArticleId","value"],"title":"StockForCreation","type":"object","description":"StockForCreation"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"StockForUpsertUpdate":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["value","id","version"],"title":"StockForUpsertUpdate","type":"object","description":"StockForUpsertUpdate"}}}}
```

## The StockSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"locationName":{"enum":["ASC","DESC"],"type":"string"},"tenantArticleId":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"StockSort","type":"object","description":"StockSort"}}}}
```

## The StockStorageLocationTraitEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockStorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StockStorageLocationTraitEnumFilter","type":"object","description":"StockStorageLocationTraitEnumFilter"}}}}
```

## The StockStorageLocationTraitEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockStorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StockStorageLocationTraitEnumListFilter","type":"object","description":"StockStorageLocationTraitEnumListFilter"},"StockStorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StockStorageLocationTraitEnumFilter","type":"object","description":"StockStorageLocationTraitEnumFilter"}}}}
```

## The StockSummaries object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockSummaries":{"properties":{"stockSummaries":{"items":{"$ref":"#/components/schemas/StockSummary"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","stockSummaries"],"title":"StockSummaries","type":"object","description":"StockSummaries"},"StockSummary":{"properties":{"article":{"$ref":"#/components/schemas/StockSummaryArticle"},"details":{"$ref":"#/components/schemas/StockSummaryDetails"},"includedFacilityRefs":{"description":"ALPHA Status!. The facilityRefs that are included in the stock summary.","items":{"type":"string"},"type":"array"}},"required":["includedFacilityRefs","article","details"],"title":"StockSummary","type":"object","description":"StockSummary"},"StockSummaryArticle":{"properties":{"imageUrl":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["tenantArticleId","title"],"title":"StockSummaryArticle","type":"object","description":"StockSummaryArticle"},"StockSummaryDetails":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","minimum":0,"type":"number"},"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/ByTrait"},"channelAdjusted":{"items":{"$ref":"#/components/schemas/ChannelStockAvailability"},"type":"array"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"minimum":0,"type":"number"},"safetyStock":{"minimum":0,"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"minimum":0,"type":"number"}},"required":["reserved","totalAmount","available","safetyStock","byTrait","availableForPicking","availableToPromise","readyToPick","availableOnStock","stockOnHand"],"title":"StockSummaryDetails","type":"object","description":"StockSummaryDetails"},"ByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"ByTrait","type":"object","description":"ByTrait"},"ChannelStockAvailability":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"channelRef":{"type":"string"}},"required":["channelRef","availableForPicking","availableOnStock"],"title":"ChannelStockAvailability","type":"object","description":"ChannelStockAvailability"}}}}
```

## The StockSummary object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockSummary":{"properties":{"article":{"$ref":"#/components/schemas/StockSummaryArticle"},"details":{"$ref":"#/components/schemas/StockSummaryDetails"},"includedFacilityRefs":{"description":"ALPHA Status!. The facilityRefs that are included in the stock summary.","items":{"type":"string"},"type":"array"}},"required":["includedFacilityRefs","article","details"],"title":"StockSummary","type":"object","description":"StockSummary"},"StockSummaryArticle":{"properties":{"imageUrl":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["tenantArticleId","title"],"title":"StockSummaryArticle","type":"object","description":"StockSummaryArticle"},"StockSummaryDetails":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","minimum":0,"type":"number"},"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/ByTrait"},"channelAdjusted":{"items":{"$ref":"#/components/schemas/ChannelStockAvailability"},"type":"array"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"minimum":0,"type":"number"},"safetyStock":{"minimum":0,"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"minimum":0,"type":"number"}},"required":["reserved","totalAmount","available","safetyStock","byTrait","availableForPicking","availableToPromise","readyToPick","availableOnStock","stockOnHand"],"title":"StockSummaryDetails","type":"object","description":"StockSummaryDetails"},"ByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"ByTrait","type":"object","description":"ByTrait"},"ChannelStockAvailability":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"channelRef":{"type":"string"}},"required":["channelRef","availableForPicking","availableOnStock"],"title":"ChannelStockAvailability","type":"object","description":"ChannelStockAvailability"}}}}
```

## The StockSummaryArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockSummaryArticle":{"properties":{"imageUrl":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["tenantArticleId","title"],"title":"StockSummaryArticle","type":"object","description":"StockSummaryArticle"}}}}
```

## The StockSummaryDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockSummaryDetails":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","minimum":0,"type":"number"},"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/ByTrait"},"channelAdjusted":{"items":{"$ref":"#/components/schemas/ChannelStockAvailability"},"type":"array"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"minimum":0,"type":"number"},"safetyStock":{"minimum":0,"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"minimum":0,"type":"number"}},"required":["reserved","totalAmount","available","safetyStock","byTrait","availableForPicking","availableToPromise","readyToPick","availableOnStock","stockOnHand"],"title":"StockSummaryDetails","type":"object","description":"StockSummaryDetails"},"ByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"ByTrait","type":"object","description":"ByTrait"},"ChannelStockAvailability":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"channelRef":{"type":"string"}},"required":["channelRef","availableForPicking","availableOnStock"],"title":"ChannelStockAvailability","type":"object","description":"ChannelStockAvailability"}}}}
```

## The StockUpsertOperationResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockUpsertOperationResult":{"properties":{"status":{"enum":["UPDATED","CREATED","UNCHANGED"],"type":"string"},"stock":{"$ref":"#/components/schemas/Stock"}},"required":["stock","status"],"title":"StockUpsertOperationResult","type":"object","description":"StockUpsertOperationResult"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StockVersionlessUpsertActionResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StockVersionlessUpsertActionResult":{"properties":{"operationResults":{"$ref":"#/components/schemas/StockUpsertOperationResult"}},"required":["operationResults"],"title":"StockVersionlessUpsertActionResult","type":"object","description":"StockVersionlessUpsertActionResult"},"StockUpsertOperationResult":{"properties":{"status":{"enum":["UPDATED","CREATED","UNCHANGED"],"type":"string"},"stock":{"$ref":"#/components/schemas/Stock"}},"required":["stock","status"],"title":"StockUpsertOperationResult","type":"object","description":"StockUpsertOperationResult"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"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"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StorageLocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"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"}}}}
```

## The StorageLocationAssignmentConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationAssignmentConfiguration":{"additionalProperties":false,"properties":{"storageLocationRequired":{"enum":["ALL","SOME","NONE"],"type":"string"}},"required":["storageLocationRequired"],"type":"object","title":"StorageLocationAssignmentConfiguration","description":"StorageLocationAssignmentConfiguration"}}}}
```

## The StorageLocationBulkEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationBulkEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StorageLocationEventPayload"},"type":"array"}},"required":["items"],"title":"StorageLocationBulkEventPayload","type":"object","description":"StorageLocationBulkEventPayload"},"StorageLocationEventPayload":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"id":{"type":"string"},"information":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"type":"string"},"runningSequences":{"items":{"$ref":"#/components/schemas/StorageLocationEventSequenceItem"},"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"tenantLocationId":{"type":"string"},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationEventTraitConfigInner"},"type":"array"},"traits":{"items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["version","id","facilityRef","traits","name","type","scannableCodes","runningSequences"],"title":"StorageLocationEventPayload","type":"object","description":"StorageLocationEventPayload"},"StorageLocationEventSequenceItem":{"properties":{"nextStorageLocationRef":{"type":"string"},"previousStorageLocationRef":{"type":"string"},"score":{"type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"title":"StorageLocationEventSequenceItem","type":"object","description":"StorageLocationEventSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationEventTraitConfigInner":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"title":"StorageLocationEventTraitConfigInner","type":"object","description":"StorageLocationEventTraitConfigInner"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"}}}}
```

## The StorageLocationBulkWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationBulkWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/StorageLocationBulkEventPayload"}},"required":["payload"],"title":"StorageLocationBulkWebHookEvent","type":"object","description":"StorageLocationBulkWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"StorageLocationBulkEventPayload":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StorageLocationEventPayload"},"type":"array"}},"required":["items"],"title":"StorageLocationBulkEventPayload","type":"object","description":"StorageLocationBulkEventPayload"},"StorageLocationEventPayload":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"id":{"type":"string"},"information":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"type":"string"},"runningSequences":{"items":{"$ref":"#/components/schemas/StorageLocationEventSequenceItem"},"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"tenantLocationId":{"type":"string"},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationEventTraitConfigInner"},"type":"array"},"traits":{"items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["version","id","facilityRef","traits","name","type","scannableCodes","runningSequences"],"title":"StorageLocationEventPayload","type":"object","description":"StorageLocationEventPayload"},"StorageLocationEventSequenceItem":{"properties":{"nextStorageLocationRef":{"type":"string"},"previousStorageLocationRef":{"type":"string"},"score":{"type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"title":"StorageLocationEventSequenceItem","type":"object","description":"StorageLocationEventSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationEventTraitConfigInner":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"title":"StorageLocationEventTraitConfigInner","type":"object","description":"StorageLocationEventTraitConfigInner"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"}}}}
```

## The StorageLocationEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationEventPayload":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"id":{"type":"string"},"information":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"type":"string"},"runningSequences":{"items":{"$ref":"#/components/schemas/StorageLocationEventSequenceItem"},"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"tenantLocationId":{"type":"string"},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationEventTraitConfigInner"},"type":"array"},"traits":{"items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["version","id","facilityRef","traits","name","type","scannableCodes","runningSequences"],"title":"StorageLocationEventPayload","type":"object","description":"StorageLocationEventPayload"},"StorageLocationEventSequenceItem":{"properties":{"nextStorageLocationRef":{"type":"string"},"previousStorageLocationRef":{"type":"string"},"score":{"type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"title":"StorageLocationEventSequenceItem","type":"object","description":"StorageLocationEventSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationEventTraitConfigInner":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"title":"StorageLocationEventTraitConfigInner","type":"object","description":"StorageLocationEventTraitConfigInner"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"}}}}
```

## The StorageLocationEventSequenceItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationEventSequenceItem":{"properties":{"nextStorageLocationRef":{"type":"string"},"previousStorageLocationRef":{"type":"string"},"score":{"type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"title":"StorageLocationEventSequenceItem","type":"object","description":"StorageLocationEventSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"}}}}
```

## The StorageLocationEventTraitConfigInner object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationEventTraitConfigInner":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"title":"StorageLocationEventTraitConfigInner","type":"object","description":"StorageLocationEventTraitConfigInner"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"}}}}
```

## The StorageLocationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"}}}}
```

## The StorageLocationForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"}}}}
```

## The StorageLocationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"storageLocations":{"items":{"$ref":"#/components/schemas/StorageLocation"},"type":"array"},"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","storageLocations"],"title":"StorageLocationPaginatedResult","type":"object","description":"StorageLocationPaginatedResult"},"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"},"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"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"}}}}
```

## The StorageLocationPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationPatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyStorageLocationAction"},"minItems":1,"type":"array"},"version":{"description":"The version of the facility where we want to patch the storage locations to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"StorageLocationPatchActions"},"title":"StorageLocationPatchActions","description":"StorageLocationPatchActions"},"ModifyStorageLocationAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyStorageLocation', because you want to modify a storage location","enum":["ModifyStorageLocation"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the storage location. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"deprecated":true,"description":"The traits of this storage location. Do not use this to write traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs.","type":"string"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyStorageLocationAction"},"title":"ModifyStorageLocationAction","description":"ModifyStorageLocationAction"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"}}}}
```

## The StorageLocationRecommendation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationRecommendation":{"properties":{"stockCount":{"type":"number"},"storageLocation":{"$ref":"#/components/schemas/StorageLocation"}},"required":["storageLocation","stockCount"],"title":"StorageLocationRecommendation","type":"object","description":"StorageLocationRecommendation"},"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"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"}}}}
```

## The StorageLocationReferencedFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationReferencedFilter":{"properties":{"stock":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedStockFilter"}],"description":"Nested search by stock"}},"title":"StorageLocationReferencedFilter","type":"object","description":"StorageLocationReferencedFilter"},"StorageLocationReferencedStockFilter":{"properties":{"hasStocks":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Whether the storage locations has any stocks on it."},"sumOfValues":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"The sum of all stock values in this storage location, i.e. how much stock is stored in this location."}},"title":"StorageLocationReferencedStockFilter","type":"object","description":"StorageLocationReferencedStockFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"}}}}
```

## The StorageLocationReferencedStockFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationReferencedStockFilter":{"properties":{"hasStocks":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Whether the storage locations has any stocks on it."},"sumOfValues":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"The sum of all stock values in this storage location, i.e. how much stock is stored in this location."}},"title":"StorageLocationReferencedStockFilter","type":"object","description":"StorageLocationReferencedStockFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"}}}}
```

## The StorageLocationSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationSearchPayload":{"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/StorageLocationSearchQuery"},"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/StorageLocationSort"},"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":"StorageLocationSearchPayload","type":"object","description":"StorageLocationSearchPayload"},"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"},"StorageLocationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"maxItems":500,"type":"array"},"referenced":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedFilter"}],"description":"Nested search by referenced"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"tenantLocationId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantLocationId"},"traits":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumListFilter"}],"description":"Search by traits"},"type":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTypeEnumFilter"}],"description":"Search by type"},"zoneRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by zoneRef"}},"title":"StorageLocationSearchQuery","type":"object","description":"StorageLocationSearchQuery"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"StorageLocationReferencedFilter":{"properties":{"stock":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedStockFilter"}],"description":"Nested search by stock"}},"title":"StorageLocationReferencedFilter","type":"object","description":"StorageLocationReferencedFilter"},"StorageLocationReferencedStockFilter":{"properties":{"hasStocks":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Whether the storage locations has any stocks on it."},"sumOfValues":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"The sum of all stock values in this storage location, i.e. how much stock is stored in this location."}},"title":"StorageLocationReferencedStockFilter","type":"object","description":"StorageLocationReferencedStockFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StorageLocationTraitEnumListFilter","type":"object","description":"StorageLocationTraitEnumListFilter"},"StorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StorageLocationTraitEnumFilter","type":"object","description":"StorageLocationTraitEnumFilter"},"StorageLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"}},"title":"StorageLocationTypeEnumFilter","type":"object","description":"StorageLocationTypeEnumFilter"},"StorageLocationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantLocationId":{"enum":["ASC","DESC"],"type":"string"},"zoneRef":{"enum":["ASC","DESC"],"type":"string"}},"title":"StorageLocationSort","type":"object","description":"StorageLocationSort"}}}}
```

## The StorageLocationSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"maxItems":500,"type":"array"},"referenced":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedFilter"}],"description":"Nested search by referenced"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"tenantLocationId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantLocationId"},"traits":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumListFilter"}],"description":"Search by traits"},"type":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTypeEnumFilter"}],"description":"Search by type"},"zoneRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by zoneRef"}},"title":"StorageLocationSearchQuery","type":"object","description":"StorageLocationSearchQuery"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"StorageLocationReferencedFilter":{"properties":{"stock":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedStockFilter"}],"description":"Nested search by stock"}},"title":"StorageLocationReferencedFilter","type":"object","description":"StorageLocationReferencedFilter"},"StorageLocationReferencedStockFilter":{"properties":{"hasStocks":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Whether the storage locations has any stocks on it."},"sumOfValues":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"The sum of all stock values in this storage location, i.e. how much stock is stored in this location."}},"title":"StorageLocationReferencedStockFilter","type":"object","description":"StorageLocationReferencedStockFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StorageLocationTraitEnumListFilter","type":"object","description":"StorageLocationTraitEnumListFilter"},"StorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StorageLocationTraitEnumFilter","type":"object","description":"StorageLocationTraitEnumFilter"},"StorageLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"}},"title":"StorageLocationTypeEnumFilter","type":"object","description":"StorageLocationTypeEnumFilter"}}}}
```

## The StorageLocationSequenceItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"}}}}
```

## The StorageLocationSequenceType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"}}}}
```

## The StorageLocationSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantLocationId":{"enum":["ASC","DESC"],"type":"string"},"zoneRef":{"enum":["ASC","DESC"],"type":"string"}},"title":"StorageLocationSort","type":"object","description":"StorageLocationSort"}}}}
```

## The StorageLocationTrait object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"}}}}
```

## The StorageLocationTraitConfig object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"}}}}
```

## The StorageLocationTraitConfigEntry object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StorageLocationTraitEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StorageLocationTraitEnumFilter","type":"object","description":"StorageLocationTraitEnumFilter"}}}}
```

## The StorageLocationTraitEnumListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StorageLocationTraitEnumListFilter","type":"object","description":"StorageLocationTraitEnumListFilter"},"StorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StorageLocationTraitEnumFilter","type":"object","description":"StorageLocationTraitEnumFilter"}}}}
```

## The StorageLocationType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"}}}}
```

## The StorageLocationTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"}},"title":"StorageLocationTypeEnumFilter","type":"object","description":"StorageLocationTypeEnumFilter"}}}}
```

## The StowedStowLineItemStowTo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"}}}}
```

## The StowedStowLineItemStowToForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"}}}}
```

## The StowJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"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"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"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"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"}}}}
```

## The StowJobActionName object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobActionName":{"description":"The name of the action that should be performed","enum":["START_STOW_JOB","PAUSE_STOW_JOB","OPEN_STOW_JOB","CANCEL_STOW_JOB","CLOSE_STOW_JOB","MODIFY_STOW_LINE_ITEMS","REPLACE_ASSIGNED_USERS"],"type":"string","xml":{"name":"StowJobActionName"},"title":"StowJobActionName"}}}}
```

## The StowJobForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobForCreation":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationById"},{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUser"}]},"maxItems":20,"type":"array"},"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"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItemForCreation"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"}},"required":["facilityRef","status","stowLineItems"],"title":"StowJobForCreation","type":"object","description":"StowJobForCreation"},"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"},"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"},"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"},"StowLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"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"},"reasons":{"description":"The reasons for the stow operation. Each reason can either be a stand-alone reason, or a preconfigured reasons by specifying the tenantReasonId and/or the id of the reason. If tenantReasonId and id are specified, they have to match.","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonInput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToForCreation"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFromForCreation"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom"],"title":"StowLineItemForCreation","type":"object","description":"StowLineItemForCreation"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonInput":{"properties":{"reasonLocalized":{"description":"List of localized reason strings. If provided, no preconfiguration is necessary. Cannot be provided in combination with id or existing tenantReasonId.","type":"object"},"id":{"description":"ID of reason. Use to enrich with preconfigured reason","type":"string"},"tenantReasonId":{"description":"tenantReasonId of reason. If no reasonLocalized provided, a preconfigured reason with the tenantReasonId must be present","type":"string"}},"title":"ExternalStockChangeReasonInput","type":"object","description":"ExternalStockChangeReasonInput"},"StowLineItemStowToForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowToForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowToForCreation","type":"object","description":"StowLineItemStowToForCreation"},"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"},"StowLineItemTakeFromForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFromForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFromForCreation","type":"object","description":"StowLineItemTakeFromForCreation"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFromForCreation":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFromForCreation","type":"object","description":"TakenStowLineItemTakeFromForCreation"}}}}
```

## The StowJobForPatch object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobForPatch":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationById"},{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUser"}]},"maxItems":20,"type":"array"},"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"},"priority":{"description":"Information for user about which job should be started first","type":"number"},"targetTime":{"format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms","type":"number"}},"required":["version"],"title":"StowJobForPatch","type":"object","description":"StowJobForPatch"},"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"},"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"},"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"}}}}
```

## The StowJobPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"stowJobs":{"items":{"$ref":"#/components/schemas/StowJob"},"type":"array"},"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","stowJobs"],"title":"StowJobPaginatedResult","type":"object","description":"StowJobPaginatedResult"},"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"},"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"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"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"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"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"}}}}
```

## The StowJobReplaceAssignedUsersAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobReplaceAssignedUsersAction":{"description":"REPLACE_ASSIGNED_USERS replaces the assigned users of the stow job","properties":{"assignedUsers":{"description":"The users are assigned to the stow job","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationById"},{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUser"}]},"maxItems":20,"type":"array"},"name":{"description":"The name of the action that should be performed","enum":["REPLACE_ASSIGNED_USERS"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name","assignedUsers"],"title":"StowJobReplaceAssignedUsersAction","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"},"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"},"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"}}}}
```

## The StowJobSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobSearchPayload":{"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/StowJobSearchQuery"},"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/StowJobSort"},"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":"StowJobSearchPayload","type":"object","description":"StowJobSearchPayload"},"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"},"StowJobSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/StowJobSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"default":{"after":"-P1W"},"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/StowJobSearchQuery"},"maxItems":500,"type":"array"},"priority":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by priority"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/StowJobStatusTypeEnumFilter"}],"description":"Search by status"},"stowLineItems":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsListFilter"}],"description":"Nested list search by stowLineItems"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"StowJobSearchQuery","type":"object","description":"StowJobSearchQuery"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StowJobStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"}},"title":"StowJobStatusTypeEnumFilter","type":"object","description":"StowJobStatusTypeEnumFilter"},"StowJobStowLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsListFilter","type":"object","description":"StowJobStowLineItemsListFilter"},"StowJobStowLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsArticleFilter"}],"description":"Nested search by article"},"heldStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by heldStockRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"stowTo":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToListFilter"}],"description":"Nested list search by stowTo"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromFilter"}],"description":"Nested search by takeFrom"}},"title":"StowJobStowLineItemsFilter","type":"object","description":"StowJobStowLineItemsFilter"},"StowJobStowLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"StowJobStowLineItemsArticleFilter","type":"object","description":"StowJobStowLineItemsArticleFilter"},"StowJobStowLineItemsStowToListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsStowToListFilter","type":"object","description":"StowJobStowLineItemsStowToListFilter"},"StowJobStowLineItemsStowToFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToStowedFilter"}],"description":"Nested search by stowed"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsStowToFilter","type":"object","description":"StowJobStowLineItemsStowToFilter"},"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"},"StowJobStowLineItemsTakeFromFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"taken":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromTakenFilter"}],"description":"Nested search by taken"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsTakeFromFilter","type":"object","description":"StowJobStowLineItemsTakeFromFilter"},"StowJobStowLineItemsTakeFromTakenFilter":{"properties":{"takenStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by takenStockRef"}},"title":"StowJobStowLineItemsTakeFromTakenFilter","type":"object","description":"StowJobStowLineItemsTakeFromTakenFilter"},"StowJobSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"StowJobSort","type":"object","description":"StowJobSort"}}}}
```

## The StowJobSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/StowJobSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"default":{"after":"-P1W"},"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/StowJobSearchQuery"},"maxItems":500,"type":"array"},"priority":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by priority"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/StowJobStatusTypeEnumFilter"}],"description":"Search by status"},"stowLineItems":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsListFilter"}],"description":"Nested list search by stowLineItems"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"StowJobSearchQuery","type":"object","description":"StowJobSearchQuery"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"},"notIn":{"items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StowJobStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"}},"title":"StowJobStatusTypeEnumFilter","type":"object","description":"StowJobStatusTypeEnumFilter"},"StowJobStowLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsListFilter","type":"object","description":"StowJobStowLineItemsListFilter"},"StowJobStowLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsArticleFilter"}],"description":"Nested search by article"},"heldStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by heldStockRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"stowTo":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToListFilter"}],"description":"Nested list search by stowTo"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromFilter"}],"description":"Nested search by takeFrom"}},"title":"StowJobStowLineItemsFilter","type":"object","description":"StowJobStowLineItemsFilter"},"StowJobStowLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"StowJobStowLineItemsArticleFilter","type":"object","description":"StowJobStowLineItemsArticleFilter"},"StowJobStowLineItemsStowToListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsStowToListFilter","type":"object","description":"StowJobStowLineItemsStowToListFilter"},"StowJobStowLineItemsStowToFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToStowedFilter"}],"description":"Nested search by stowed"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsStowToFilter","type":"object","description":"StowJobStowLineItemsStowToFilter"},"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"},"StowJobStowLineItemsTakeFromFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"taken":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromTakenFilter"}],"description":"Nested search by taken"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsTakeFromFilter","type":"object","description":"StowJobStowLineItemsTakeFromFilter"},"StowJobStowLineItemsTakeFromTakenFilter":{"properties":{"takenStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by takenStockRef"}},"title":"StowJobStowLineItemsTakeFromTakenFilter","type":"object","description":"StowJobStowLineItemsTakeFromTakenFilter"}}}}
```

## The StowJobSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"StowJobSort","type":"object","description":"StowJobSort"}}}}
```

## The StowJobStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStatus":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string","xml":{"name":"StowJobStatus"},"title":"StowJobStatus"}}}}
```

## The StowJobStatusTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"}},"title":"StowJobStatusTypeEnumFilter","type":"object","description":"StowJobStatusTypeEnumFilter"}}}}
```

## The StowJobStockInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## The StowJobStowLineItemsArticleFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStowLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"StowJobStowLineItemsArticleFilter","type":"object","description":"StowJobStowLineItemsArticleFilter"},"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"}}}}
```

## The StowJobStowLineItemsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStowLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsArticleFilter"}],"description":"Nested search by article"},"heldStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by heldStockRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"stowTo":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToListFilter"}],"description":"Nested list search by stowTo"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromFilter"}],"description":"Nested search by takeFrom"}},"title":"StowJobStowLineItemsFilter","type":"object","description":"StowJobStowLineItemsFilter"},"StowJobStowLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"StowJobStowLineItemsArticleFilter","type":"object","description":"StowJobStowLineItemsArticleFilter"},"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"},"StowJobStowLineItemsStowToListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsStowToListFilter","type":"object","description":"StowJobStowLineItemsStowToListFilter"},"StowJobStowLineItemsStowToFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToStowedFilter"}],"description":"Nested search by stowed"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsStowToFilter","type":"object","description":"StowJobStowLineItemsStowToFilter"},"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"},"StowJobStowLineItemsTakeFromFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"taken":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromTakenFilter"}],"description":"Nested search by taken"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsTakeFromFilter","type":"object","description":"StowJobStowLineItemsTakeFromFilter"},"StowJobStowLineItemsTakeFromTakenFilter":{"properties":{"takenStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by takenStockRef"}},"title":"StowJobStowLineItemsTakeFromTakenFilter","type":"object","description":"StowJobStowLineItemsTakeFromTakenFilter"}}}}
```

## The StowJobStowLineItemsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStowLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsListFilter","type":"object","description":"StowJobStowLineItemsListFilter"},"StowJobStowLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsArticleFilter"}],"description":"Nested search by article"},"heldStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by heldStockRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"stowTo":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToListFilter"}],"description":"Nested list search by stowTo"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromFilter"}],"description":"Nested search by takeFrom"}},"title":"StowJobStowLineItemsFilter","type":"object","description":"StowJobStowLineItemsFilter"},"StowJobStowLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"StowJobStowLineItemsArticleFilter","type":"object","description":"StowJobStowLineItemsArticleFilter"},"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"},"StowJobStowLineItemsStowToListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsStowToListFilter","type":"object","description":"StowJobStowLineItemsStowToListFilter"},"StowJobStowLineItemsStowToFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToStowedFilter"}],"description":"Nested search by stowed"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsStowToFilter","type":"object","description":"StowJobStowLineItemsStowToFilter"},"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"},"StowJobStowLineItemsTakeFromFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"taken":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromTakenFilter"}],"description":"Nested search by taken"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsTakeFromFilter","type":"object","description":"StowJobStowLineItemsTakeFromFilter"},"StowJobStowLineItemsTakeFromTakenFilter":{"properties":{"takenStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by takenStockRef"}},"title":"StowJobStowLineItemsTakeFromTakenFilter","type":"object","description":"StowJobStowLineItemsTakeFromTakenFilter"}}}}
```

## The StowJobStowLineItemsStowToFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStowLineItemsStowToFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToStowedFilter"}],"description":"Nested search by stowed"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsStowToFilter","type":"object","description":"StowJobStowLineItemsStowToFilter"},"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"},"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"}}}}
```

## The StowJobStowLineItemsStowToListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStowLineItemsStowToListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsStowToListFilter","type":"object","description":"StowJobStowLineItemsStowToListFilter"},"StowJobStowLineItemsStowToFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToStowedFilter"}],"description":"Nested search by stowed"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsStowToFilter","type":"object","description":"StowJobStowLineItemsStowToFilter"},"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"},"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"}}}}
```

## The StowJobStowLineItemsStowToStowedFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"},"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"}}}}
```

## The StowJobStowLineItemsTakeFromFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStowLineItemsTakeFromFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"taken":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromTakenFilter"}],"description":"Nested search by taken"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsTakeFromFilter","type":"object","description":"StowJobStowLineItemsTakeFromFilter"},"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"},"StowJobStowLineItemsTakeFromTakenFilter":{"properties":{"takenStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by takenStockRef"}},"title":"StowJobStowLineItemsTakeFromTakenFilter","type":"object","description":"StowJobStowLineItemsTakeFromTakenFilter"}}}}
```

## The StowJobStowLineItemsTakeFromTakenFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobStowLineItemsTakeFromTakenFilter":{"properties":{"takenStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by takenStockRef"}},"title":"StowJobStowLineItemsTakeFromTakenFilter","type":"object","description":"StowJobStowLineItemsTakeFromTakenFilter"},"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"}}}}
```

## The StowJobWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJobWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/StowJob"}},"required":["payload"],"title":"StowJobWebHookEvent","type":"object","description":"StowJobWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"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"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"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"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"}}}}
```

## The StowLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"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"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"}}}}
```

## The StowLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"}}}}
```

## The StowLineItemForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"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"},"reasons":{"description":"The reasons for the stow operation. Each reason can either be a stand-alone reason, or a preconfigured reasons by specifying the tenantReasonId and/or the id of the reason. If tenantReasonId and id are specified, they have to match.","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonInput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToForCreation"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFromForCreation"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom"],"title":"StowLineItemForCreation","type":"object","description":"StowLineItemForCreation"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonInput":{"properties":{"reasonLocalized":{"description":"List of localized reason strings. If provided, no preconfiguration is necessary. Cannot be provided in combination with id or existing tenantReasonId.","type":"object"},"id":{"description":"ID of reason. Use to enrich with preconfigured reason","type":"string"},"tenantReasonId":{"description":"tenantReasonId of reason. If no reasonLocalized provided, a preconfigured reason with the tenantReasonId must be present","type":"string"}},"title":"ExternalStockChangeReasonInput","type":"object","description":"ExternalStockChangeReasonInput"},"StowLineItemStowToForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowToForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowToForCreation","type":"object","description":"StowLineItemStowToForCreation"},"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"},"StowLineItemTakeFromForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFromForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFromForCreation","type":"object","description":"StowLineItemTakeFromForCreation"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFromForCreation":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFromForCreation","type":"object","description":"TakenStowLineItemTakeFromForCreation"}}}}
```

## The StowLineItemForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemForUpdate":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowLineItemArticle"}],"description":"The article that should be stowed"},"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"},"id":{"description":"The ID of the stowLineItem. Leave empty for creation","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonInput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToForUpdate"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFromForCreation"}],"description":"Instructions on how and where to take the item from"}},"title":"StowLineItemForUpdate","type":"object","description":"StowLineItemForUpdate"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"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 item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonInput":{"properties":{"reasonLocalized":{"description":"List of localized reason strings. If provided, no preconfiguration is necessary. Cannot be provided in combination with id or existing tenantReasonId.","type":"object"},"id":{"description":"ID of reason. Use to enrich with preconfigured reason","type":"string"},"tenantReasonId":{"description":"tenantReasonId of reason. If no reasonLocalized provided, a preconfigured reason with the tenantReasonId must be present","type":"string"}},"title":"ExternalStockChangeReasonInput","type":"object","description":"ExternalStockChangeReasonInput"},"StowLineItemStowToForUpdate":{"properties":{"id":{"type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowToForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowToForUpdate","type":"object","description":"StowLineItemStowToForUpdate"},"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"},"StowLineItemTakeFromForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFromForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFromForCreation","type":"object","description":"StowLineItemTakeFromForCreation"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFromForCreation":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFromForCreation","type":"object","description":"TakenStowLineItemTakeFromForCreation"}}}}
```

## The StowLineItemStowTo object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemStowTo":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowTo","type":"object","description":"StowLineItemStowTo"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"}}}}
```

## The StowLineItemStowToForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemStowToForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowToForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowToForCreation","type":"object","description":"StowLineItemStowToForCreation"},"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"}}}}
```

## The StowLineItemStowToForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemStowToForUpdate":{"properties":{"id":{"type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowToForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowToForUpdate","type":"object","description":"StowLineItemStowToForUpdate"},"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"}}}}
```

## The StowLineItemStowToType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemStowToType":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string","xml":{"name":"StowLineItemStowToType"},"title":"StowLineItemStowToType"}}}}
```

## The StowLineItemStowToWithId object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"}}}}
```

## The StowLineItemTakeFrom object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"}}}}
```

## The StowLineItemTakeFromForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemTakeFromForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFromForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFromForCreation","type":"object","description":"StowLineItemTakeFromForCreation"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFromForCreation":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFromForCreation","type":"object","description":"TakenStowLineItemTakeFromForCreation"}}}}
```

## The StowLineItemTakeFromType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowLineItemTakeFromType":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system.","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string","xml":{"name":"StowLineItemTakeFromType"},"title":"StowLineItemTakeFromType"}}}}
```

## The StringEqFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The StringFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The StringListExistsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StringListExistsFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"},"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"StringListExistsFilter","type":"object","description":"StringListExistsFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The StringListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The StringSearchFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The StringValidation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StringValidation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseValidation"}],"description":"Validate input as string.","properties":{"maxLength":{"type":"number"},"minLength":{"type":"number"}},"title":"StringValidation","type":"object"},"BaseValidation":{"properties":{"validationType":{"enum":["STRING","FLOAT","INTEGER"],"type":"string"}},"required":["validationType"],"type":"object","title":"BaseValidation","description":"BaseValidation"}}}}
```

## The StrippedBrands object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedBrands":{"properties":{"brands":{"items":{"$ref":"#/components/schemas/Brand"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedBrands","description":"StrippedBrands"},"Brand":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BrandForCreation"}],"properties":{"id":{"type":"string"},"name":{"description":"The name of the brand for this listing","type":"string"}},"required":["name","id"],"type":"object","xml":{"name":"Brand"},"title":"Brand","description":"Brand"},"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"},"BrandForCreation":{"properties":{"name":{"description":"The name of the brand for this listing","type":"string"}},"required":["name"],"type":"object","xml":{"name":"BrandForCreation"},"title":"BrandForCreation","description":"BrandForCreation"}}}}
```

## The StrippedCarrier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedCarrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"deliveryType":{"description":"The delivery type of this carrier","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"The lifecycle of this carrier","enum":["GA","BETA","ALPHA"],"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"status":{"description":"The status of this carrier","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","key","name","version"],"title":"StrippedCarrier","type":"object","description":"StrippedCarrier"}}}}
```

## The StrippedCarriers object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedCarriers":{"properties":{"carriers":{"description":"List of carriers","items":{"$ref":"#/components/schemas/StrippedCarrier"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"StrippedCarriers","type":"object","description":"StrippedCarriers"},"StrippedCarrier":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"deliveryType":{"description":"The delivery type of this carrier","enum":["SAMEDAY","DELIVERY"],"type":"string"},"id":{"description":"The id of the carrier","type":"string"},"key":{"description":"References the KEP. Currently allowed values are DHL_V2, DPD_CH, DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lifecycle":{"description":"The lifecycle of this carrier","enum":["GA","BETA","ALPHA"],"type":"string"},"name":{"description":"This is the well known name for a supported CEP partner. Can be adapted to the clients needs.","type":"string"},"status":{"description":"The status of this carrier","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["id","key","name","version"],"title":"StrippedCarrier","type":"object","description":"StrippedCarrier"}}}}
```

## The StrippedCustomServices object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedCustomServices":{"properties":{"customServices":{"description":"List of custom services matching the query","items":{"$ref":"#/components/schemas/CustomService"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"StrippedCustomServices","type":"object","description":"StrippedCustomServices"},"CustomService":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information entries defined for this custom service","items":{"$ref":"#/components/schemas/AdditionalInformation"},"maxItems":15,"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to custom service. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"description":{"description":"Translated description derived from descriptionLocalized based on the requested locale","minLength":1,"type":"string"},"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"id":{"description":"Unique ID of this custom service","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images for this custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing a service job of this custom service","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items of the custom service are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"Translated name derived from nameLocalized based on the requested locale","minLength":1,"type":"string"},"status":{"description":"Deprecated values: ENABLED and DISABLED, use INACTIVE and ACTIVE instead","enum":["ENABLED","DISABLED","INACTIVE","ACTIVE"],"type":"string"},"tenantCustomServiceId":{"description":"Tenant specific ID of the custom service","minLength":1,"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["status","nameLocalized","itemsRequired","id","created","lastModified","version"],"title":"CustomService","type":"object","description":"CustomService"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description derived from descriptionLocalized based on the requested locale","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name derived from nameLocalized based on the requested locale","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"Id to identifiy the additional information on an external system. Must be unique per CustomService.","minLength":1,"type":"string"},"valueType":{"description":"Type of the value","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"AdditionalInformation","type":"object","description":"AdditionalInformation"}}}}
```

## The StrippedFacilities object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedFacilities":{"properties":{"facilities":{"items":{"anyOf":[{"$ref":"#/components/schemas/StrippedManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedFacilities","description":"StrippedFacilities"},"StrippedManagedFacility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/Address"},{"properties":{"id":{"type":"string"},"name":{"description":"name of the facility","type":"string"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"}},"required":["id","status","type"],"type":"object"}],"title":"StrippedManagedFacility","description":"StrippedManagedFacility"},"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"},"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"},"maxItems":500,"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"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"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"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The StrippedFacilityCustomServiceConnections object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedFacilityCustomServiceConnections":{"properties":{"facilityCustomServiceConnections":{"description":"List of facility to custom service connections matching the query","items":{"$ref":"#/components/schemas/FacilityCustomServiceConnection"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"StrippedFacilityCustomServiceConnections","type":"object","description":"StrippedFacilityCustomServiceConnections"},"FacilityCustomServiceConnection":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customServiceRef":{"description":"ID of the custom service this connection belongs to","minLength":1,"type":"string"},"executionTimeInMin":{"description":"Time in minutes the custom service takes to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the facility this connection belongs to","minLength":1,"type":"string"},"id":{"description":"Unique ID of this facility to custom service connection","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"status":{"description":"Status of the connection between facility and custom service","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["status","id","version","created","lastModified","facilityRef","customServiceRef"],"title":"FacilityCustomServiceConnection","type":"object","description":"FacilityCustomServiceConnection"}}}}
```

## The StrippedFilterEntities object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedFilterEntities":{"properties":{"filterEntities":{"items":{"$ref":"#/components/schemas/FilterEntity"},"type":"array"},"total":{"description":"Total number of found filter entities for this query","type":"integer"}},"type":"object","title":"StrippedFilterEntities","description":"StrippedFilterEntities"},"FilterEntity":{"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupportedFilterEntityTypesEnum"},"value":{"type":"string"}},"required":["valueLocalized","id","type"],"type":"object","xml":{"name":"FilterEntity"},"title":"FilterEntity","description":"FilterEntity"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SupportedFilterEntityTypesEnum":{"description":"Entity types supported as filter entities","enum":["STICKER"],"type":"string","title":"SupportedFilterEntityTypesEnum"}}}}
```

## The StrippedHandoverContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedHandoverContainer":{"properties":{"handoverContainer":{"items":{"$ref":"#/components/schemas/HandoverContainer"},"type":"array"},"total":{"description":"total number for the given filter","type":"integer"}},"required":["total","handoverContainer"],"title":"StrippedHandoverContainer","type":"object","description":"StrippedHandoverContainer"},"HandoverContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"type":"string"},"type":"array"},"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"type":"object"},"description":{"description":"Translated Description from descriptionLocalized","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"References to the documents that are related to this handover container.","type":"string"},"facilityRef":{"description":"Linked Facility through reference","type":"string"},"handoverJobRef":{"description":"Linked HandoverJob through reference","type":"string"},"iconUrl":{"description":"URL to icon","type":"string"},"id":{"description":"Unique identifier of the handover container","type":"string"},"identifierCode":{"description":"The identifier code generated for this container at creation time, used to render its identifier document.","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/HandoverContainerLineItem"},"type":"array"},"name":{"description":"Translated name from nameLocalized","type":"string"},"operativeContainerTypeRef":{"description":"Linked Operative Container Type through reference","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"processRef":{"description":"Linked Process through reference","type":"string"},"sequenceNumber":{"format":"int32","maximum":10000,"minimum":0,"type":"integer"},"stackRef":{"description":"Linked stack through reference","type":"string"},"storageLocationRef":{"description":"Linked StorageLocation through reference","type":"string"},"type":{"description":"Type of the container. Can either be PHYSICAL or VIRTUAL.","enum":["PHYSICAL","VIRTUAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit in gram for this Container","type":"integer"}},"required":["created","lastModified","version","id","facilityRef","processRef","stackRef","lineItems","handoverJobRef","nameLocalized","type"],"title":"HandoverContainer","type":"object","description":"HandoverContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"HandoverContainerLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverContainerLineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Amount per line item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"HandoverContainerLineItem","type":"object","description":"HandoverContainerLineItem"},"HandoverContainerLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"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. Ensure that no authentication is needed 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":"HandoverContainerLineItemArticle","type":"object","description":"HandoverContainerLineItemArticle"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The StrippedHandoverjob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedHandoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"carrierKey":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo","type":"string","deprecated":true},"channel":{"$ref":"#/components/schemas/HandoverjobChannel"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"pickupIdentifier":{"description":"A short, human readable code used to identify this handoverjob when a customer collects the order at the facility, either by scanning a QR code or by typing the code into a search. It is generated automatically during creation and cannot be set or changed by clients. Consists of 10 characters from the alphabet 0123456789ABCDEFGHJKMNPQRSTVWXYZ, which omits the easily confused letters I, L, O and U. Clients may display it grouped, for example H7K29-XQRM4. The code is drawn at random from a space of 32^10 and uniqueness is not enforced, so a lookup by pickupIdentifier can in rare cases return more than one handoverjob and clients should be able to handle that.","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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"HandoverjobChannel":{"enum":["DELIVERY","COLLECT"],"type":"string","title":"HandoverjobChannel","description":"HandoverjobChannel"},"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"},"maxItems":500,"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"}}}}
```

## The StrippedHandoverjobs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo","type":"string","deprecated":true},"channel":{"$ref":"#/components/schemas/HandoverjobChannel"},"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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"pickupIdentifier":{"description":"A short, human readable code used to identify this handoverjob when a customer collects the order at the facility, either by scanning a QR code or by typing the code into a search. It is generated automatically during creation and cannot be set or changed by clients. Consists of 10 characters from the alphabet 0123456789ABCDEFGHJKMNPQRSTVWXYZ, which omits the easily confused letters I, L, O and U. Clients may display it grouped, for example H7K29-XQRM4. The code is drawn at random from a space of 32^10 and uniqueness is not enforced, so a lookup by pickupIdentifier can in rare cases return more than one handoverjob and clients should be able to handle that.","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, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@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"},"HandoverjobChannel":{"enum":["DELIVERY","COLLECT"],"type":"string","title":"HandoverjobChannel","description":"HandoverjobChannel"},"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"},"maxItems":500,"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"}}}}
```

## The StrippedInboundProcess object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedInboundProcess":{"properties":{"anonymized":{"description":"Indicates the inbound process was anonymized acording to configured GDPR retention time.","type":"boolean"},"created":{"format":"date-time","type":"string"},"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"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundDate":{"description":"Aggregated dates from sources which advise incoming stock. Currently that is \"purchaseOrder\"","items":{"format":"date-time","type":"string"},"type":"array"},"lastModified":{"format":"date-time","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"origin":{"description":"Aggregated origin data from sources which advise incoming stock. Currently that is just  \"purchaseOrder\"","items":{"$ref":"#/components/schemas/InboundProcessOrigin"},"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessId":{"type":"string"},"version":{"type":"number"}},"required":["facilityRef","id","version","created","lastModified","inboundDate","origin","anonymized","status","onHold","scannableCodes"],"title":"StrippedInboundProcess","type":"object","description":"StrippedInboundProcess"},"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"}}}}
```

## The StrippedListing object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedListing":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"id":{"type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","type":"string"}},"required":["status","facilityId","id","tenantArticleId"],"type":"object"}],"title":"StrippedListing","description":"StrippedListing"},"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"}}}}
```

## The StrippedListings object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedListings":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/StrippedListing"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedListings","description":"StrippedListings"},"StrippedListing":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"id":{"type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","type":"string"}},"required":["status","facilityId","id","tenantArticleId"],"type":"object"}],"title":"StrippedListing","description":"StrippedListing"},"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"}}}}
```

## The StrippedManagedFacility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedManagedFacility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/Address"},{"properties":{"id":{"type":"string"},"name":{"description":"name of the facility","type":"string"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"}},"required":["id","status","type"],"type":"object"}],"title":"StrippedManagedFacility","description":"StrippedManagedFacility"},"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"},"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"},"maxItems":500,"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"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"}}}}
```

## The StrippedOidcProvider object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedOidcProvider":{"properties":{"assignedGroups":{"description":"The assigned groups of the OIDC provider","items":{"$ref":"#/components/schemas/AssignedGroup"},"type":"array"},"clientId":{"description":"The client id of the OIDC provider","type":"string"},"customParameters":{"description":"The custom parameters of the OIDC provider","items":{"$ref":"#/components/schemas/OidcProviderCustomParameter"},"type":"array"},"id":{"description":"The id of the OIDC provider","type":"string"},"issuer":{"description":"The issuer of the OIDC provider","type":"string"},"name":{"description":"The name of the OIDC provider","type":"string"},"roleManagementMode":{"description":"Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.","enum":["IDP_MANAGED","IDP_IDENTITY_ONLY"],"type":"string"},"status":{"description":"The status of the OIDC provider","enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"description":"The version of the OIDC provider","type":"number"}},"required":["name","status","issuer","clientId","customParameters","assignedGroups","id","version"],"title":"StrippedOidcProvider","type":"object","description":"StrippedOidcProvider"},"AssignedGroup":{"properties":{"facilityRefs":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"}},"required":["facilityRefs","group"],"title":"AssignedGroup","type":"object","description":"AssignedGroup"},"OidcProviderCustomParameter":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"title":"OidcProviderCustomParameter","type":"object","description":"OidcProviderCustomParameter"}}}}
```

## The StrippedOrder object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedOrder":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"properties":{"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"title":{"type":"string"}},"required":["quantity","title"],"type":"object"},"type":"array"},"processRef":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"}},"required":["id","status","orderDate"],"type":"object"}],"title":"StrippedOrder","description":"StrippedOrder"},"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"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The StrippedOrders object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedOrders":{"properties":{"orders":{"items":{"$ref":"#/components/schemas/StrippedOrder"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedOrders","description":"StrippedOrders"},"StrippedOrder":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"properties":{"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"title":{"type":"string"}},"required":["quantity","title"],"type":"object"},"type":"array"},"processRef":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"}},"required":["id","status","orderDate"],"type":"object"}],"title":"StrippedOrder","description":"StrippedOrder"},"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"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The StrippedPackingSourceContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"}}}}
```

## The StrippedParcel object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedParcel":{"properties":{"carrierRef":{"description":"The reference to the carrier for which the parcel is assigned to","type":"string"},"carrierTrackingNumber":{"type":"string"},"parcelRef":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"}},"required":["parcelRef","carrierRef","status"],"type":"object","title":"StrippedParcel","description":"StrippedParcel"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"}}}}
```

## The StrippedParcels object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedParcels":{"properties":{"parcels":{"items":{"$ref":"#/components/schemas/StrippedParcel"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedParcels","description":"StrippedParcels"},"StrippedParcel":{"properties":{"carrierRef":{"description":"The reference to the carrier for which the parcel is assigned to","type":"string"},"carrierTrackingNumber":{"type":"string"},"parcelRef":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"}},"required":["parcelRef","carrierRef","status"],"type":"object","title":"StrippedParcel","description":"StrippedParcel"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"}}}}
```

## The StrippedPickJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedPickJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"carrierKey":{"type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"type":"string"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"searchPaths":{"items":{"type":"string"},"minItems":0,"type":"array"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"required":["id","status","created","lastModified","version"],"type":"object"}],"title":"StrippedPickJob","description":"StrippedPickJob"},"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"},"PickJobStatus":{"description":"The status of a pickjob.","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string","xml":{"name":"PickJobStatus"},"title":"PickJobStatus"}}}}
```

## The StrippedPickJobs object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedPickJobs":{"properties":{"pickjobs":{"items":{"$ref":"#/components/schemas/StrippedPickJob"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedPickJobs","description":"StrippedPickJobs"},"StrippedPickJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"carrierKey":{"type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"type":"string"},"orderRef":{"description":"The id of the order that lead to the creation of this pickjob. Can be empty / not present when the pickjob was created without having an order.","type":"string"},"searchPaths":{"items":{"type":"string"},"minItems":0,"type":"array"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"required":["id","status","created","lastModified","version"],"type":"object"}],"title":"StrippedPickJob","description":"StrippedPickJob"},"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"},"PickJobStatus":{"description":"The status of a pickjob.","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string","xml":{"name":"PickJobStatus"},"title":"PickJobStatus"}}}}
```

## The StrippedReservation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedReservation":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"StrippedReservation","type":"object","description":"StrippedReservation"}}}}
```

## The StrippedShipments object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedShipments":{"properties":{"shipments":{"items":{"$ref":"#/components/schemas/ShipmentWithSearchPath"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedShipments","description":"StrippedShipments"},"ShipmentWithSearchPath":{"allOf":[{"$ref":"#/components/schemas/Shipment"},{"additionalProperties":false,"properties":{"searchPaths":{"items":{"type":"string"},"minItems":0,"type":"array"}},"type":"object"}],"title":"ShipmentWithSearchPath","description":"ShipmentWithSearchPath"},"Shipment":{"allOf":[{"$ref":"#/components/schemas/ShipmentForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"default":false,"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierKey":{"type":"string"},"hasActiveCarrier":{"default":true,"description":"Indicates if there is an active carrier configuration to fulfill this shipment","type":"boolean"},"id":{"description":"The id of this Shipment. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItem"},"type":"array"},"parcels":{"items":{"$ref":"#/components/schemas/StrippedParcel"},"type":"array"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","hasActiveCarrier","workflowInformation"],"type":"object"}],"title":"Shipment","description":"Shipment"},"ShipmentForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the shipment. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"description":"The reference to the facility which the shipment is assigned to.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The id of the facility reference.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"sourceAddress":{"$ref":"#/components/schemas/FacilityAddress"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"},"tenantOrderId":{"description":"Reference to the order in the tenant system.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["facilityRef","targetTime","orderDate"],"type":"object","xml":{"name":"Shipment"},"title":"ShipmentForCreation","description":"ShipmentForCreation"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"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"},"maxItems":500,"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"},"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"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"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"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"},"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"},"ShipmentLineItem":{"allOf":[{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"}},"required":["id"],"type":"object"}],"title":"ShipmentLineItem","description":"ShipmentLineItem"},"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"},"StrippedParcel":{"properties":{"carrierRef":{"description":"The reference to the carrier for which the parcel is assigned to","type":"string"},"carrierTrackingNumber":{"type":"string"},"parcelRef":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"}},"required":["parcelRef","carrierRef","status"],"type":"object","title":"StrippedParcel","description":"StrippedParcel"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The StrippedShippingTargetAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedShippingTargetAddress":{"properties":{"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"postalCode":{"pattern":"^.+","type":"string"}},"type":"object","title":"StrippedShippingTargetAddress","description":"StrippedShippingTargetAddress"}}}}
```

## The StrippedTags object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StrippedTags":{"properties":{"total":{"description":"Total number of found entities for this query","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object","title":"StrippedTags","description":"StrippedTags"},"Tag":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"xml":{"name":"Tag"},"title":"Tag","description":"Tag"},"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"},"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"}}}}
```

## The Subscription object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Subscription":{"allOf":[{"$ref":"#/components/schemas/SubscriptionForCreation"}],"properties":{"created":{"description":"The date this subscription was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"id":{"type":"string"}},"required":["id","created"],"type":"object","title":"Subscription","description":"Subscription"},"SubscriptionForCreation":{"additionalProperties":false,"properties":{"callbackUrl":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use new 'target' object instead.","type":"string"},"contexts":{"description":"Optional context filters to limit which events trigger the subscription based on facility relationships. Multiple contexts are evaluated with logical AND. FACILITY context can only appear once, FACILITY_GROUP contexts can appear multiple times.","items":{"$ref":"#/components/schemas/SubscriptionContext"},"type":"array"},"event":{"description":"Name of the event in the fulfillmenttools platform.","type":"string"},"headers":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use new 'target' object instead.","items":{"$ref":"#/components/schemas/CallbackHeader"},"minItems":1,"type":"array"},"name":{"description":"Name of the event, this is freely selectable.","type":"string"},"target":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionTargetWebhook"},{"$ref":"#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBus"},{"$ref":"#/components/schemas/SubscriptionTargetGoogleCloudPubSub"}]}},"required":["name","event"],"type":"object","title":"SubscriptionForCreation","description":"SubscriptionForCreation"},"SubscriptionContext":{"description":"Context filter for subscriptions to limit events based on facility relationships.","properties":{"type":{"$ref":"#/components/schemas/SubscriptionContextType"},"values":{"description":"Array of facility IDs or facility group names to filter by.","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["type","values"],"title":"SubscriptionContext","type":"object"},"SubscriptionContextType":{"description":"Types of context filters for subscriptions.","enum":["FACILITY","FACILITY_GROUP"],"title":"SubscriptionContextType","type":"string"},"CallbackHeader":{"description":"Header for the Webhook call.","properties":{"key":{"description":"This is the key of the header. e.g.: `Authorization`","type":"string"},"value":{"description":"This is the value for the header. e.g.: `Basic dXNlcm5hbWU6cGFzc3dvcmQ=`","type":"string"}},"required":["key","value"],"title":"CallbackHeader","type":"object"},"SubscriptionTargetWebhook":{"additionalProperties":false,"description":"Subscriptions model for a Webhook target.","properties":{"callbackUrl":{"type":"string"},"headers":{"items":{"$ref":"#/components/schemas/CallbackHeader"},"minItems":1,"type":"array"},"type":{"$ref":"#/components/schemas/SubscriptionTargetWebhookEnum"}},"required":["type","callbackUrl"],"title":"SubscriptionTargetWebhook","type":"object"},"SubscriptionTargetWebhookEnum":{"description":"Type of subscription target webhook.","enum":["WEBHOOK"],"title":"SubscriptionTargetWebhookEnum","type":"string"},"SubscriptionTargetMicrosoftAzureServiceBus":{"additionalProperties":false,"description":"Subscriptions model for a Microsoft Azure Service Bus target.","properties":{"clientId":{"description":"'Application (Client) ID' from the app registration in 'Microsoft Entra ID' (formerly 'Azure AD').","minLength":1,"type":"string"},"clientSecret":{"description":"Client secret from the used Azure application.","minLength":1,"type":"string"},"namespace":{"description":"The Azure Service Bus namespace.","minLength":1,"type":"string"},"queueOrTopicName":{"description":"Name of the queue or topic in the Service Bus namespace.","minLength":1,"type":"string"},"tenantId":{"description":"'Directory (Tenant) ID' from the app registration in 'Microsoft Entra ID' (formerly 'Azure AD').","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBusEnum"}},"required":["type","tenantId","clientId","clientSecret","namespace","queueOrTopicName"],"title":"SubscriptionTargetMicrosoftAzureServiceBus","type":"object"},"SubscriptionTargetMicrosoftAzureServiceBusEnum":{"description":"Type of subscription target Microsoft Azure Service Bus.","enum":["MICROSOFT_AZURE_SERVICE_BUS"],"title":"SubscriptionTargetMicrosoftAzureServiceBusEnum","type":"string"},"SubscriptionTargetGoogleCloudPubSub":{"additionalProperties":false,"description":"Subscriptions model for a Google Cloud Pub/Sub target.","properties":{"projectId":{"description":"Id of the Google Cloud project.","minLength":1,"type":"string"},"topicId":{"description":"Id of the Google Cloud Pub/Sub topic.","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/SubscriptionTargetGoogleCloudPubSubEnum"}},"required":["type","projectId","topicId"],"title":"SubscriptionTargetGoogleCloudPubSub","type":"object"},"SubscriptionTargetGoogleCloudPubSubEnum":{"description":"Type of subscription target Google Cloud Pub/Sub.","enum":["GOOGLE_CLOUD_PUB_SUB"],"title":"SubscriptionTargetGoogleCloudPubSubEnum","type":"string"}}}}
```

## The SubscriptionContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionContext":{"description":"Context filter for subscriptions to limit events based on facility relationships.","properties":{"type":{"$ref":"#/components/schemas/SubscriptionContextType"},"values":{"description":"Array of facility IDs or facility group names to filter by.","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["type","values"],"title":"SubscriptionContext","type":"object"},"SubscriptionContextType":{"description":"Types of context filters for subscriptions.","enum":["FACILITY","FACILITY_GROUP"],"title":"SubscriptionContextType","type":"string"}}}}
```

## The SubscriptionContextType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionContextType":{"description":"Types of context filters for subscriptions.","enum":["FACILITY","FACILITY_GROUP"],"title":"SubscriptionContextType","type":"string"}}}}
```

## The SubscriptionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionForCreation":{"additionalProperties":false,"properties":{"callbackUrl":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use new 'target' object instead.","type":"string"},"contexts":{"description":"Optional context filters to limit which events trigger the subscription based on facility relationships. Multiple contexts are evaluated with logical AND. FACILITY context can only appear once, FACILITY_GROUP contexts can appear multiple times.","items":{"$ref":"#/components/schemas/SubscriptionContext"},"type":"array"},"event":{"description":"Name of the event in the fulfillmenttools platform.","type":"string"},"headers":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use new 'target' object instead.","items":{"$ref":"#/components/schemas/CallbackHeader"},"minItems":1,"type":"array"},"name":{"description":"Name of the event, this is freely selectable.","type":"string"},"target":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionTargetWebhook"},{"$ref":"#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBus"},{"$ref":"#/components/schemas/SubscriptionTargetGoogleCloudPubSub"}]}},"required":["name","event"],"type":"object","title":"SubscriptionForCreation","description":"SubscriptionForCreation"},"SubscriptionContext":{"description":"Context filter for subscriptions to limit events based on facility relationships.","properties":{"type":{"$ref":"#/components/schemas/SubscriptionContextType"},"values":{"description":"Array of facility IDs or facility group names to filter by.","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["type","values"],"title":"SubscriptionContext","type":"object"},"SubscriptionContextType":{"description":"Types of context filters for subscriptions.","enum":["FACILITY","FACILITY_GROUP"],"title":"SubscriptionContextType","type":"string"},"CallbackHeader":{"description":"Header for the Webhook call.","properties":{"key":{"description":"This is the key of the header. e.g.: `Authorization`","type":"string"},"value":{"description":"This is the value for the header. e.g.: `Basic dXNlcm5hbWU6cGFzc3dvcmQ=`","type":"string"}},"required":["key","value"],"title":"CallbackHeader","type":"object"},"SubscriptionTargetWebhook":{"additionalProperties":false,"description":"Subscriptions model for a Webhook target.","properties":{"callbackUrl":{"type":"string"},"headers":{"items":{"$ref":"#/components/schemas/CallbackHeader"},"minItems":1,"type":"array"},"type":{"$ref":"#/components/schemas/SubscriptionTargetWebhookEnum"}},"required":["type","callbackUrl"],"title":"SubscriptionTargetWebhook","type":"object"},"SubscriptionTargetWebhookEnum":{"description":"Type of subscription target webhook.","enum":["WEBHOOK"],"title":"SubscriptionTargetWebhookEnum","type":"string"},"SubscriptionTargetMicrosoftAzureServiceBus":{"additionalProperties":false,"description":"Subscriptions model for a Microsoft Azure Service Bus target.","properties":{"clientId":{"description":"'Application (Client) ID' from the app registration in 'Microsoft Entra ID' (formerly 'Azure AD').","minLength":1,"type":"string"},"clientSecret":{"description":"Client secret from the used Azure application.","minLength":1,"type":"string"},"namespace":{"description":"The Azure Service Bus namespace.","minLength":1,"type":"string"},"queueOrTopicName":{"description":"Name of the queue or topic in the Service Bus namespace.","minLength":1,"type":"string"},"tenantId":{"description":"'Directory (Tenant) ID' from the app registration in 'Microsoft Entra ID' (formerly 'Azure AD').","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBusEnum"}},"required":["type","tenantId","clientId","clientSecret","namespace","queueOrTopicName"],"title":"SubscriptionTargetMicrosoftAzureServiceBus","type":"object"},"SubscriptionTargetMicrosoftAzureServiceBusEnum":{"description":"Type of subscription target Microsoft Azure Service Bus.","enum":["MICROSOFT_AZURE_SERVICE_BUS"],"title":"SubscriptionTargetMicrosoftAzureServiceBusEnum","type":"string"},"SubscriptionTargetGoogleCloudPubSub":{"additionalProperties":false,"description":"Subscriptions model for a Google Cloud Pub/Sub target.","properties":{"projectId":{"description":"Id of the Google Cloud project.","minLength":1,"type":"string"},"topicId":{"description":"Id of the Google Cloud Pub/Sub topic.","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/SubscriptionTargetGoogleCloudPubSubEnum"}},"required":["type","projectId","topicId"],"title":"SubscriptionTargetGoogleCloudPubSub","type":"object"},"SubscriptionTargetGoogleCloudPubSubEnum":{"description":"Type of subscription target Google Cloud Pub/Sub.","enum":["GOOGLE_CLOUD_PUB_SUB"],"title":"SubscriptionTargetGoogleCloudPubSubEnum","type":"string"}}}}
```

## The Subscriptions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Subscriptions":{"properties":{"subscriptions":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"Subscriptions","description":"Subscriptions"},"Subscription":{"allOf":[{"$ref":"#/components/schemas/SubscriptionForCreation"}],"properties":{"created":{"description":"The date this subscription was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"id":{"type":"string"}},"required":["id","created"],"type":"object","title":"Subscription","description":"Subscription"},"SubscriptionForCreation":{"additionalProperties":false,"properties":{"callbackUrl":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use new 'target' object instead.","type":"string"},"contexts":{"description":"Optional context filters to limit which events trigger the subscription based on facility relationships. Multiple contexts are evaluated with logical AND. FACILITY context can only appear once, FACILITY_GROUP contexts can appear multiple times.","items":{"$ref":"#/components/schemas/SubscriptionContext"},"type":"array"},"event":{"description":"Name of the event in the fulfillmenttools platform.","type":"string"},"headers":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use new 'target' object instead.","items":{"$ref":"#/components/schemas/CallbackHeader"},"minItems":1,"type":"array"},"name":{"description":"Name of the event, this is freely selectable.","type":"string"},"target":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionTargetWebhook"},{"$ref":"#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBus"},{"$ref":"#/components/schemas/SubscriptionTargetGoogleCloudPubSub"}]}},"required":["name","event"],"type":"object","title":"SubscriptionForCreation","description":"SubscriptionForCreation"},"SubscriptionContext":{"description":"Context filter for subscriptions to limit events based on facility relationships.","properties":{"type":{"$ref":"#/components/schemas/SubscriptionContextType"},"values":{"description":"Array of facility IDs or facility group names to filter by.","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["type","values"],"title":"SubscriptionContext","type":"object"},"SubscriptionContextType":{"description":"Types of context filters for subscriptions.","enum":["FACILITY","FACILITY_GROUP"],"title":"SubscriptionContextType","type":"string"},"CallbackHeader":{"description":"Header for the Webhook call.","properties":{"key":{"description":"This is the key of the header. e.g.: `Authorization`","type":"string"},"value":{"description":"This is the value for the header. e.g.: `Basic dXNlcm5hbWU6cGFzc3dvcmQ=`","type":"string"}},"required":["key","value"],"title":"CallbackHeader","type":"object"},"SubscriptionTargetWebhook":{"additionalProperties":false,"description":"Subscriptions model for a Webhook target.","properties":{"callbackUrl":{"type":"string"},"headers":{"items":{"$ref":"#/components/schemas/CallbackHeader"},"minItems":1,"type":"array"},"type":{"$ref":"#/components/schemas/SubscriptionTargetWebhookEnum"}},"required":["type","callbackUrl"],"title":"SubscriptionTargetWebhook","type":"object"},"SubscriptionTargetWebhookEnum":{"description":"Type of subscription target webhook.","enum":["WEBHOOK"],"title":"SubscriptionTargetWebhookEnum","type":"string"},"SubscriptionTargetMicrosoftAzureServiceBus":{"additionalProperties":false,"description":"Subscriptions model for a Microsoft Azure Service Bus target.","properties":{"clientId":{"description":"'Application (Client) ID' from the app registration in 'Microsoft Entra ID' (formerly 'Azure AD').","minLength":1,"type":"string"},"clientSecret":{"description":"Client secret from the used Azure application.","minLength":1,"type":"string"},"namespace":{"description":"The Azure Service Bus namespace.","minLength":1,"type":"string"},"queueOrTopicName":{"description":"Name of the queue or topic in the Service Bus namespace.","minLength":1,"type":"string"},"tenantId":{"description":"'Directory (Tenant) ID' from the app registration in 'Microsoft Entra ID' (formerly 'Azure AD').","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBusEnum"}},"required":["type","tenantId","clientId","clientSecret","namespace","queueOrTopicName"],"title":"SubscriptionTargetMicrosoftAzureServiceBus","type":"object"},"SubscriptionTargetMicrosoftAzureServiceBusEnum":{"description":"Type of subscription target Microsoft Azure Service Bus.","enum":["MICROSOFT_AZURE_SERVICE_BUS"],"title":"SubscriptionTargetMicrosoftAzureServiceBusEnum","type":"string"},"SubscriptionTargetGoogleCloudPubSub":{"additionalProperties":false,"description":"Subscriptions model for a Google Cloud Pub/Sub target.","properties":{"projectId":{"description":"Id of the Google Cloud project.","minLength":1,"type":"string"},"topicId":{"description":"Id of the Google Cloud Pub/Sub topic.","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/SubscriptionTargetGoogleCloudPubSubEnum"}},"required":["type","projectId","topicId"],"title":"SubscriptionTargetGoogleCloudPubSub","type":"object"},"SubscriptionTargetGoogleCloudPubSubEnum":{"description":"Type of subscription target Google Cloud Pub/Sub.","enum":["GOOGLE_CLOUD_PUB_SUB"],"title":"SubscriptionTargetGoogleCloudPubSubEnum","type":"string"}}}}
```

## The SubscriptionTargetGoogleCloudPubSub object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionTargetGoogleCloudPubSub":{"additionalProperties":false,"description":"Subscriptions model for a Google Cloud Pub/Sub target.","properties":{"projectId":{"description":"Id of the Google Cloud project.","minLength":1,"type":"string"},"topicId":{"description":"Id of the Google Cloud Pub/Sub topic.","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/SubscriptionTargetGoogleCloudPubSubEnum"}},"required":["type","projectId","topicId"],"title":"SubscriptionTargetGoogleCloudPubSub","type":"object"},"SubscriptionTargetGoogleCloudPubSubEnum":{"description":"Type of subscription target Google Cloud Pub/Sub.","enum":["GOOGLE_CLOUD_PUB_SUB"],"title":"SubscriptionTargetGoogleCloudPubSubEnum","type":"string"}}}}
```

## The SubscriptionTargetGoogleCloudPubSubEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionTargetGoogleCloudPubSubEnum":{"description":"Type of subscription target Google Cloud Pub/Sub.","enum":["GOOGLE_CLOUD_PUB_SUB"],"title":"SubscriptionTargetGoogleCloudPubSubEnum","type":"string"}}}}
```

## The SubscriptionTargetMicrosoftAzureServiceBus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionTargetMicrosoftAzureServiceBus":{"additionalProperties":false,"description":"Subscriptions model for a Microsoft Azure Service Bus target.","properties":{"clientId":{"description":"'Application (Client) ID' from the app registration in 'Microsoft Entra ID' (formerly 'Azure AD').","minLength":1,"type":"string"},"clientSecret":{"description":"Client secret from the used Azure application.","minLength":1,"type":"string"},"namespace":{"description":"The Azure Service Bus namespace.","minLength":1,"type":"string"},"queueOrTopicName":{"description":"Name of the queue or topic in the Service Bus namespace.","minLength":1,"type":"string"},"tenantId":{"description":"'Directory (Tenant) ID' from the app registration in 'Microsoft Entra ID' (formerly 'Azure AD').","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBusEnum"}},"required":["type","tenantId","clientId","clientSecret","namespace","queueOrTopicName"],"title":"SubscriptionTargetMicrosoftAzureServiceBus","type":"object"},"SubscriptionTargetMicrosoftAzureServiceBusEnum":{"description":"Type of subscription target Microsoft Azure Service Bus.","enum":["MICROSOFT_AZURE_SERVICE_BUS"],"title":"SubscriptionTargetMicrosoftAzureServiceBusEnum","type":"string"}}}}
```

## The SubscriptionTargetMicrosoftAzureServiceBusEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionTargetMicrosoftAzureServiceBusEnum":{"description":"Type of subscription target Microsoft Azure Service Bus.","enum":["MICROSOFT_AZURE_SERVICE_BUS"],"title":"SubscriptionTargetMicrosoftAzureServiceBusEnum","type":"string"}}}}
```

## The SubscriptionTargetWebhook object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionTargetWebhook":{"additionalProperties":false,"description":"Subscriptions model for a Webhook target.","properties":{"callbackUrl":{"type":"string"},"headers":{"items":{"$ref":"#/components/schemas/CallbackHeader"},"minItems":1,"type":"array"},"type":{"$ref":"#/components/schemas/SubscriptionTargetWebhookEnum"}},"required":["type","callbackUrl"],"title":"SubscriptionTargetWebhook","type":"object"},"CallbackHeader":{"description":"Header for the Webhook call.","properties":{"key":{"description":"This is the key of the header. e.g.: `Authorization`","type":"string"},"value":{"description":"This is the value for the header. e.g.: `Basic dXNlcm5hbWU6cGFzc3dvcmQ=`","type":"string"}},"required":["key","value"],"title":"CallbackHeader","type":"object"},"SubscriptionTargetWebhookEnum":{"description":"Type of subscription target webhook.","enum":["WEBHOOK"],"title":"SubscriptionTargetWebhookEnum","type":"string"}}}}
```

## The SubscriptionTargetWebhookEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubscriptionTargetWebhookEnum":{"description":"Type of subscription target webhook.","enum":["WEBHOOK"],"title":"SubscriptionTargetWebhookEnum","type":"string"}}}}
```

## The Substitute object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"}}}}
```

## The SubstituteAttributeItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"}}}}
```

## The SubstitutedLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The SubstituteForOrderedItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The SubstituteLineItem object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"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":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"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 article that needs to be picked to substitute the item","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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"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"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"}}}}
```

## The SubstituteLineItemArticle object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"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. Ensure that no authentication is needed 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/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"}}}}
```

## The SubstituteLineItemForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubstituteLineItemForUpsert":{"properties":{"id":{"description":"The id of the substitute line item to update. If none is passed, a new substitute line item will be created.","type":"string"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"tenantArticleId":{"description":"TenantArticleId of the substitute article","type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"SubstituteLineItemForUpsert","description":"SubstituteLineItemForUpsert"}}}}
```

## The SubstituteLineItemPartialStockLocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The Substitutes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Substitutes":{"allOf":[{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/SubstitutesForUpsert"}],"required":["tenantArticleId","substitutes"],"type":"object","xml":{"name":"Substitutes"},"title":"Substitutes","description":"Substitutes"},"Entity":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"description":"The id of the entity.","type":"string"}},"required":["id"],"type":"object","title":"Entity","description":"Entity"},"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"},"SubstitutesForUpsert":{"properties":{"substitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"tenantArticleId":{"type":"string"},"version":{"description":"Version field is used in the optimistic locking process. If the Substitute is for the tenantArticleId is not set yet, this field is ignored.","type":"number"}},"required":["substitutes","version","tenantArticleId"],"type":"object","xml":{"name":"SubstitutesForUpsert"},"title":"SubstitutesForUpsert","description":"SubstitutesForUpsert"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"}}}}
```

## The SubstitutesForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubstitutesForUpsert":{"properties":{"substitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"tenantArticleId":{"type":"string"},"version":{"description":"Version field is used in the optimistic locking process. If the Substitute is for the tenantArticleId is not set yet, this field is ignored.","type":"number"}},"required":["substitutes","version","tenantArticleId"],"type":"object","xml":{"name":"SubstitutesForUpsert"},"title":"SubstitutesForUpsert","description":"SubstitutesForUpsert"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"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"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"}}}}
```

## The SubstitutionConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SubstitutionConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"description":"Substitution Configuration","properties":{"active":{"default":true,"description":"Toggle for substitution articles.","type":"boolean"}},"required":["active"],"title":"SubstitutionConfiguration","type":"object"},"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"}}}}
```

## The Supplier object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"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"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"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"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The SupplierAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"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"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The SupplierAddressEmailAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"}}}}
```

## The SupplierAddressForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"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"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"}}}}
```

## The SupplierAddressPhoneNumber object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"}}}}
```

## The SupplierForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"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"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"}}}}
```

## The SupplierForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupplierForModification":{"additionalProperties":false,"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"}],"nullable":true,"type":"object"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","nullable":true,"type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"nullable":true,"type":"array"}},"required":["type","version"],"type":"object","title":"SupplierForModification","description":"SupplierForModification"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"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"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The SupplierForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupplierForReplacement":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["version","name","status","type"],"type":"object","discriminator":{"propertyName":"type"},"xml":{"name":"SupplierForReplacement"},"title":"SupplierForReplacement","description":"SupplierForReplacement"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"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"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"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","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The SupplyingFacilityConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"}}}}
```

## The SupportActivationRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportActivationRequest":{"properties":{"durationHours":{"description":"Duration in hours (1-3)","type":"number"},"name":{"description":"The action to perform","enum":["ACTIVATE_SUPPORT_MODE"],"type":"string"},"reason":{"description":"Reason for activating support mode","type":"string"},"supportTicket":{"description":"Optional support ticket reference","type":"string"}},"required":["name","reason","durationHours"],"title":"SupportActivationRequest","type":"object","description":"SupportActivationRequest"}}}}
```

## The SupportDeactivationRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportDeactivationRequest":{"properties":{"name":{"description":"The action to perform","enum":["DEACTIVATE_SUPPORT_MODE"],"type":"string"}},"required":["name"],"title":"SupportDeactivationRequest","type":"object","description":"SupportDeactivationRequest"}}}}
```

## The SupportedEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportedEvent":{"properties":{"description":{"type":"string"},"event":{"type":"string"}},"type":"object","title":"SupportedEvent","description":"SupportedEvent"}}}}
```

## The SupportedEvents object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportedEvents":{"properties":{"supportedEvents":{"items":{"$ref":"#/components/schemas/SupportedEvent"},"type":"array"}},"type":"object","title":"SupportedEvents","description":"SupportedEvents"},"SupportedEvent":{"properties":{"description":{"type":"string"},"event":{"type":"string"}},"type":"object","title":"SupportedEvent","description":"SupportedEvent"}}}}
```

## The SupportedFilterEntityTypesEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportedFilterEntityTypesEnum":{"description":"Entity types supported as filter entities","enum":["STICKER"],"type":"string","title":"SupportedFilterEntityTypesEnum"}}}}
```

## The SupportedLocale object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"}}}}
```

## The SupportedLocales object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportedLocales":{"items":{"$ref":"#/components/schemas/SupportedLocale"},"type":"array","title":"SupportedLocales","description":"SupportedLocales"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"}}}}
```

## The SupportExtensionRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportExtensionRequest":{"properties":{"additionalHours":{"description":"Additional hours to extend (1-3, max total 5 hours)","type":"number"},"name":{"description":"The action to perform","enum":["EXTEND_SUPPORT_SESSION"],"type":"string"},"reason":{"description":"Reason for extension","type":"string"}},"required":["name","additionalHours","reason"],"title":"SupportExtensionRequest","type":"object","description":"SupportExtensionRequest"}}}}
```

## The SupportStatusRequest object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SupportStatusRequest":{"properties":{"name":{"description":"The action to perform","enum":["CHECK_SUPPORT_STATUS"],"type":"string"}},"required":["name"],"title":"SupportStatusRequest","type":"object","description":"SupportStatusRequest"}}}}
```

## The Tag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Tag":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"xml":{"name":"Tag"},"title":"Tag","description":"Tag"},"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"},"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"}}}}
```

## The TagConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"}}}}
```

## The TagForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"}}}}
```

## The TagPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagPaginatedResult":{"properties":{"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"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"required":["pageInfo","tags"],"title":"TagPaginatedResult","type":"object","description":"TagPaginatedResult"},"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"},"Tag":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"xml":{"name":"Tag"},"title":"Tag","description":"Tag"},"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"},"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"}}}}
```

## The TagPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/AddAllowedValueToTag"}]},"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":"TagPatchActions"},"title":"TagPatchActions","description":"TagPatchActions"},"AddAllowedValueToTag":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'AddAllowedValueToTag', because you want to add an allowed value to a tag","enum":["AddAllowedValueToTag"],"type":"string"},"allowedValue":{"type":"string"}},"required":["action","allowedValue"],"type":"object"}],"description":"Action to add allowed values to a tag","title":"AddAllowedValueToTag","xml":{"name":"AddAllowedValueToTag"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The TagReference object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## The TagScanningConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagScanningConfiguration":{"additionalProperties":false,"properties":{"offeredScanningRuleByTag":{"items":{"$ref":"#/components/schemas/OfferedScanningRuleByTag"},"type":"array"}},"title":"TagScanningConfiguration","description":"TagScanningConfiguration"},"OfferedScanningRuleByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"scanningType":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"tagRef":{"minLength":1,"type":"string"}},"required":["tagRef","matchingValues","scanningType"],"type":"object","title":"OfferedScanningRuleByTag","description":"OfferedScanningRuleByTag"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"}}}}
```

## The TagSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagSearchPayload":{"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/TagSearchQuery"},"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/TagSort"},"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":"TagSearchPayload","type":"object","description":"TagSearchPayload"},"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"},"TagSearchQuery":{"properties":{"allowedValues":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by allowedValues"},"and":{"items":{"$ref":"#/components/schemas/TagSearchQuery"},"maxItems":500,"type":"array"},"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/TagSearchQuery"},"maxItems":500,"type":"array"}},"title":"TagSearchQuery","type":"object","description":"TagSearchQuery"},"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"},"TagSort":{"properties":{"id":{"enum":["ASC","DESC"],"type":"string"}},"title":"TagSort","type":"object","description":"TagSort"}}}}
```

## The TagSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagSearchQuery":{"properties":{"allowedValues":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by allowedValues"},"and":{"items":{"$ref":"#/components/schemas/TagSearchQuery"},"maxItems":500,"type":"array"},"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/TagSearchQuery"},"maxItems":500,"type":"array"}},"title":"TagSearchQuery","type":"object","description":"TagSearchQuery"},"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"}}}}
```

## The TagSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TagSort":{"properties":{"id":{"enum":["ASC","DESC"],"type":"string"}},"title":"TagSort","type":"object","description":"TagSort"}}}}
```

## The TakenStowLineItemTakeFrom object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"}}}}
```

## The TakenStowLineItemTakeFromForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TakenStowLineItemTakeFromForCreation":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFromForCreation","type":"object","description":"TakenStowLineItemTakeFromForCreation"}}}}
```

## The TakeOverPickJobConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TakeOverPickJobConfiguration":{"properties":{"active":{"default":false,"description":"Enable or disable pick job takeover","type":"boolean"}},"required":["active"],"type":"object","title":"TakeOverPickJobConfiguration","description":"TakeOverPickJobConfiguration"}}}}
```

## The TakeOverPickRunActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TakeOverPickRunActionEnum":{"enum":["TAKE_OVER_PICK_RUN"],"type":"string","title":"TakeOverPickRunActionEnum","description":"TakeOverPickRunActionEnum"}}}}
```

## The TakeOverPickRunActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TakeOverPickRunActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/TakeOverPickRunActionEnum"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version"],"title":"TakeOverPickRunActionParameter","type":"object","description":"TakeOverPickRunActionParameter"},"TakeOverPickRunActionEnum":{"enum":["TAKE_OVER_PICK_RUN"],"type":"string","title":"TakeOverPickRunActionEnum","description":"TakeOverPickRunActionEnum"}}}}
```

## The TakeOverPickRunConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TakeOverPickRunConfiguration":{"properties":{"active":{"default":false,"description":"Enable or disable pick run takeover","type":"boolean"}},"required":["active"],"type":"object","title":"TakeOverPickRunConfiguration","description":"TakeOverPickRunConfiguration"}}}}
```

## The TargetAddress object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TargetAddress":{"allOf":[{"$ref":"#/components/schemas/ConsumerAddress"},{"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"tenantFacilityId":{"description":"The tenantFacilityId of the facility. The given ID has to be present in the system.","type":"string"}},"type":"object"}],"type":"object","title":"TargetAddress","description":"TargetAddress"},"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"},"maxItems":500,"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"}}}}
```

## The TenantConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TenantConfiguration":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"clearName":{"type":"string"},"domainStatusMappingConfiguration":{"$ref":"#/components/schemas/DomainStatusMappingConfiguration"}},"required":["clearName"],"type":"object","title":"TenantConfiguration","description":"TenantConfiguration"},"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"},"DomainStatusMappingConfiguration":{"additionalProperties":false,"deprecated":true,"description":"Set status mapping configuration in their respective domains.","properties":{"pickingMappingConfiguration":{"$ref":"#/components/schemas/PickingDomainStatusConfiguration"}},"type":"object","title":"DomainStatusMappingConfiguration"},"PickingDomainStatusConfiguration":{"additionalProperties":false,"description":"Configuration for the picking status to domainStatus mapping","properties":{"mapAbortedToFinished":{"default":false,"description":"If true, the pickJob status ABORTED will be mapped to the domainStatus FINISHED instead of STUCK","type":"boolean"}},"type":"object","title":"PickingDomainStatusConfiguration"}}}}
```

## The TenantConfigurationForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TenantConfigurationForUpsert":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"clearName":{"type":"string"},"domainStatusMappingConfiguration":{"$ref":"#/components/schemas/DomainStatusMappingConfiguration"},"version":{"type":"number"}},"required":["clearName","version"],"type":"object","title":"TenantConfigurationForUpsert","description":"TenantConfigurationForUpsert"},"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"},"DomainStatusMappingConfiguration":{"additionalProperties":false,"deprecated":true,"description":"Set status mapping configuration in their respective domains.","properties":{"pickingMappingConfiguration":{"$ref":"#/components/schemas/PickingDomainStatusConfiguration"}},"type":"object","title":"DomainStatusMappingConfiguration"},"PickingDomainStatusConfiguration":{"additionalProperties":false,"description":"Configuration for the picking status to domainStatus mapping","properties":{"mapAbortedToFinished":{"default":false,"description":"If true, the pickJob status ABORTED will be mapped to the domainStatus FINISHED instead of STUCK","type":"boolean"}},"type":"object","title":"PickingDomainStatusConfiguration"}}}}
```

## The TenantConnectorConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TenantConnectorConfiguration":{"additionalProperties":false,"properties":{"apiUrl":{"type":"string"},"app":{"$ref":"#/components/schemas/ConnectAppTypeEnum"},"firebaseAppId":{"type":"string"},"firebaseAppIdDebug":{"type":"string"},"firebaseProjectId":{"type":"string"},"firebaseWebApiKey":{"type":"string"}},"required":["app","firebaseProjectId","apiUrl","firebaseWebApiKey","firebaseAppId","firebaseAppIdDebug"],"title":"TenantConnectorConfiguration","description":"TenantConnectorConfiguration"},"ConnectAppTypeEnum":{"description":"The type of possible Apps","enum":["PICKING","INVENTORY","OPERATIONS_ANDROID","OPERATIONS_IOS","STORE_OPERATIONS_IOS","STORE_OPERATIONS_ANDROID"],"type":"string","title":"ConnectAppTypeEnum"}}}}
```

## The TenantConnectorConfigurations object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TenantConnectorConfigurations":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"connectApps":{"description":"All possible apps","items":{"$ref":"#/components/schemas/TenantConnectorConfiguration"},"minItems":1,"type":"array"}},"required":["version","connectApps"],"type":"object","title":"TenantConnectorConfigurations","description":"TenantConnectorConfigurations"},"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"},"TenantConnectorConfiguration":{"additionalProperties":false,"properties":{"apiUrl":{"type":"string"},"app":{"$ref":"#/components/schemas/ConnectAppTypeEnum"},"firebaseAppId":{"type":"string"},"firebaseAppIdDebug":{"type":"string"},"firebaseProjectId":{"type":"string"},"firebaseWebApiKey":{"type":"string"}},"required":["app","firebaseProjectId","apiUrl","firebaseWebApiKey","firebaseAppId","firebaseAppIdDebug"],"title":"TenantConnectorConfiguration","description":"TenantConnectorConfiguration"},"ConnectAppTypeEnum":{"description":"The type of possible Apps","enum":["PICKING","INVENTORY","OPERATIONS_ANDROID","OPERATIONS_IOS","STORE_OPERATIONS_IOS","STORE_OPERATIONS_ANDROID"],"type":"string","title":"ConnectAppTypeEnum"}}}}
```

## The TenantFacilityIdSelector object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"}}}}
```

## The TenantSourceId object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"}}}}
```

## The ThresholdPriceValue object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The ThresholdSurchargeCostDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"}}}}
```

## The TimeRange object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"}}}}
```

## The TimeStamp object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"}}}}
```

## The TimeTriggeredConfigContextType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TimeTriggeredConfigContextType":{"enum":["FACILITY","FACILITY_GROUP"],"type":"string","title":"TimeTriggeredConfigContextType","description":"TimeTriggeredConfigContextType"}}}}
```

## The TimeTriggeredConfigurationContext object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TimeTriggeredConfigurationContext":{"additionalProperties":false,"properties":{"priority":{"minimum":0,"type":"number"},"timeTriggered":{"$ref":"#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig"},"type":{"$ref":"#/components/schemas/TimeTriggeredConfigContextType"},"values":{"description":"The id of the context values. For example, if the type is FACILITY, then the values are the ids of the facilities.","items":{"format":"uuid","type":"string"},"maxItems":500,"type":"array"}},"required":["priority","type","values","timeTriggered"],"type":"object","title":"TimeTriggeredConfigurationContext","description":"TimeTriggeredConfigurationContext"},"RoutingStrategyRerouteTimeTriggeredConfig":{"additionalProperties":false,"properties":{"clickAndCollectReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreDeliveryReroute":{"$ref":"#/components/schemas/RerouteConfiguration"},"shipFromStoreSamedayReroute":{"$ref":"#/components/schemas/RerouteConfiguration"}},"required":["clickAndCollectReroute","shipFromStoreDeliveryReroute","shipFromStoreSamedayReroute"],"type":"object","title":"RoutingStrategyRerouteTimeTriggeredConfig","description":"RoutingStrategyRerouteTimeTriggeredConfig"},"RerouteConfiguration":{"properties":{"active":{"type":"boolean"},"leadTimeBeforeTimeTriggeredReroute":{"deprecated":true,"description":"This setting is not supported anymore","minimum":1,"type":"number"},"rerouteAfterMinutes":{"default":1440,"description":"The amount of minutes after which an automated reroute is executed","minimum":5,"type":"number"},"rerouteStartedJobs":{"$ref":"#/components/schemas/RerouteStartedJobsConfiguration"},"rerouteTargetTimeHours":{"default":48,"description":"Only pickjobs within the target time window are considered for reroute.","minimum":1,"type":"number"}},"required":["active","rerouteTargetTimeHours","rerouteAfterMinutes"],"title":"RerouteConfiguration","description":"RerouteConfiguration"},"RerouteStartedJobsConfiguration":{"properties":{"active":{"default":false,"description":"If true, the reroute will be executed for jobs that are already started.","type":"boolean"},"minimumStartedTimeInMinutes":{"description":"The minimum time in minutes that a job must be in a started status (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to ensure that jobs are not rerouted too quickly after they have last been modified. Minimum value is 60 minutes.","minimum":60,"type":"number"}},"required":["active"],"title":"RerouteStartedJobsConfiguration","description":"RerouteStartedJobsConfiguration"},"TimeTriggeredConfigContextType":{"enum":["FACILITY","FACILITY_GROUP"],"type":"string","title":"TimeTriggeredConfigContextType","description":"TimeTriggeredConfigContextType"}}}}
```

## The TimeTriggeredRerouteFailedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TimeTriggeredRerouteFailedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/TimeTriggeredRerouteFailedWebHookEventPayload"}},"required":["payload"],"type":"object","title":"TimeTriggeredRerouteFailedWebHookEvent","description":"TimeTriggeredRerouteFailedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"TimeTriggeredRerouteFailedWebHookEventPayload":{"properties":{"facilityData":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"},"timeZone":{"type":"string"}},"required":["name","facilityRef","timeZone"]},"pickJobData":{"properties":{"created":{"format":"date-time","type":"string"},"pickJobRef":{"type":"string"},"shortId":{"type":"string"},"tenantOrderId":{"type":"string"}},"required":["pickJobRef","tenantOrderId","shortId","created"]},"processRef":{"type":"string"},"rerouteDate":{"format":"date-time","type":"string"}},"required":["processRef","pickJobData","facilityData","rerouteDate"],"title":"TimeTriggeredRerouteFailedWebHookEventPayload","description":"TimeTriggeredRerouteFailedWebHookEventPayload"}}}}
```

## The TimeTriggeredRerouteFailedWebHookEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TimeTriggeredRerouteFailedWebHookEventPayload":{"properties":{"facilityData":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"},"timeZone":{"type":"string"}},"required":["name","facilityRef","timeZone"]},"pickJobData":{"properties":{"created":{"format":"date-time","type":"string"},"pickJobRef":{"type":"string"},"shortId":{"type":"string"},"tenantOrderId":{"type":"string"}},"required":["pickJobRef","tenantOrderId","shortId","created"]},"processRef":{"type":"string"},"rerouteDate":{"format":"date-time","type":"string"}},"required":["processRef","pickJobData","facilityData","rerouteDate"],"title":"TimeTriggeredRerouteFailedWebHookEventPayload","description":"TimeTriggeredRerouteFailedWebHookEventPayload"}}}}
```

## The TimeZone object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"}}}}
```

## The TimeZoneForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"}}}}
```

## The ToolkitAllowedEntities object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"}}}}
```

## The ToolkitComparisonDecisionDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitComparisonDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Comparison Decision Detail.","properties":{"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolKitComparisonDetails"},"type":"array"}},"required":["predicates","predicateConnector","description"],"title":"ToolkitComparisonDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ToolkitRuleComparePropertiesOperatorResultExplanation":{"enum":["ALL_PREDICATES_MET","NOT_ALL_PREDICATES_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleComparePropertiesOperatorResultExplanation","description":"ToolkitRuleComparePropertiesOperatorResultExplanation"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolKitComparisonDetails":{"properties":{"evaluationResult":{"type":"boolean"},"leftPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"},"predicate":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"rightPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"}},"required":["leftPart","rightPart","evaluationResult","predicate"],"title":"ToolKitComparisonDetails","description":"ToolKitComparisonDetails"},"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolKitComparisonDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolKitComparisonDetails":{"properties":{"evaluationResult":{"type":"boolean"},"leftPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"},"predicate":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"rightPart":{"$ref":"#/components/schemas/ToolKitComparisonPart"}},"required":["leftPart","rightPart","evaluationResult","predicate"],"title":"ToolKitComparisonDetails","description":"ToolKitComparisonDetails"},"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolKitComparisonPart object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolKitComparisonPart":{"properties":{"originalValue":{"items":{"type":"string"},"type":"array"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue"],"title":"ToolKitComparisonPart","description":"ToolKitComparisonPart"}}}}
```

## The ToolkitComparisonPredicate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolkitComparisonRule object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolkitDecisionDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitDecisionDetail":{"allOf":[{"$ref":"#/components/schemas/BaseDecisionDetail"}],"description":"Toolkit Decision Detail.","properties":{"comparisonOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"description":{"type":"string"},"explanation":{"$ref":"#/components/schemas/ToolkitRuleOperatorResultExplanation"},"leftPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"leftSideEvaluation":{"type":"boolean"},"rightPredicatesDetail":{"$ref":"#/components/schemas/ToolkitPredicatesDecisionDetail"},"rightSideEvaluation":{"type":"boolean"}},"required":["decisionType","leftSideEvaluation","description"],"title":"ToolkitDecisionDetail"},"BaseDecisionDetail":{"properties":{"decisionType":{"$ref":"#/components/schemas/DecisionType"}},"required":["decisionType"],"title":"BaseDecisionDetail","description":"BaseDecisionDetail"},"DecisionType":{"enum":["FENCE","TOOLKIT","TOOLKITCOMPARISON","RATING"],"title":"DecisionType","description":"DecisionType"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitRuleOperatorResultExplanation":{"enum":["SKIPPED","BOTH_CONDITIONS_MET","ONLY_FIRST_CONDITION_MET","ONLY_SECOND_CONDITION_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleOperatorResultExplanation","description":"ToolkitRuleOperatorResultExplanation"},"ToolkitPredicatesDecisionDetail":{"properties":{"connector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicateDecisionDetail"},"type":"array"}},"required":["connector","predicates"],"title":"ToolkitPredicatesDecisionDetail","description":"ToolkitPredicatesDecisionDetail"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolkitEntityOperatorType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"}}}}
```

## The ToolkitFence object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitFence":{"allOf":[{"$ref":"#/components/schemas/ToolkitFenceForModification"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"description":"The id of the toolkit fence","type":"string"}},"required":["id"],"type":"object","xml":{"name":"ToolkitFence"},"title":"ToolkitFence","description":"ToolkitFence"},"ToolkitFenceForModification":{"allOf":[{"$ref":"#/components/schemas/ToolkitFenceForCreation"}],"properties":{"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ToolkitFenceForModification"},"title":"ToolkitFenceForModification","description":"ToolkitFenceForModification"},"ToolkitFenceForCreation":{"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"rule":{"$ref":"#/components/schemas/ToolkitRule"}},"required":["name","nameLocalized","active","order"],"type":"object","xml":{"name":"ToolkitFenceForCreation"},"title":"ToolkitFenceForCreation","description":"ToolkitFenceForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"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"}}}}
```

## The ToolkitFenceForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitFenceForCreation":{"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"rule":{"$ref":"#/components/schemas/ToolkitRule"}},"required":["name","nameLocalized","active","order"],"type":"object","xml":{"name":"ToolkitFenceForCreation"},"title":"ToolkitFenceForCreation","description":"ToolkitFenceForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"}}}}
```

## The ToolkitFenceForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitFenceForModification":{"allOf":[{"$ref":"#/components/schemas/ToolkitFenceForCreation"}],"properties":{"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ToolkitFenceForModification"},"title":"ToolkitFenceForModification","description":"ToolkitFenceForModification"},"ToolkitFenceForCreation":{"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"rule":{"$ref":"#/components/schemas/ToolkitRule"}},"required":["name","nameLocalized","active","order"],"type":"object","xml":{"name":"ToolkitFenceForCreation"},"title":"ToolkitFenceForCreation","description":"ToolkitFenceForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"}}}}
```

## The ToolkitFencesTransporter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitFencesTransporter":{"properties":{"fences":{"items":{"$ref":"#/components/schemas/ToolkitFence"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"required":["fences","total"],"type":"object","xml":{"name":"ToolkitFenceTransporter"},"title":"ToolkitFencesTransporter","description":"ToolkitFencesTransporter"},"ToolkitFence":{"allOf":[{"$ref":"#/components/schemas/ToolkitFenceForModification"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"description":"The id of the toolkit fence","type":"string"}},"required":["id"],"type":"object","xml":{"name":"ToolkitFence"},"title":"ToolkitFence","description":"ToolkitFence"},"ToolkitFenceForModification":{"allOf":[{"$ref":"#/components/schemas/ToolkitFenceForCreation"}],"properties":{"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ToolkitFenceForModification"},"title":"ToolkitFenceForModification","description":"ToolkitFenceForModification"},"ToolkitFenceForCreation":{"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not.","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this fence.","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"name":{"description":"The name of the fence.","type":"string"},"order":{"description":"Order in which this fence is executed","type":"integer"},"rule":{"$ref":"#/components/schemas/ToolkitRule"}},"required":["name","nameLocalized","active","order"],"type":"object","xml":{"name":"ToolkitFenceForCreation"},"title":"ToolkitFenceForCreation","description":"ToolkitFenceForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"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"}}}}
```

## The ToolkitOperatorType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitOperatorType":{"description":"Type of operator used for a toolkit fence or rating:\n  * `TAG_EQUALS`- the entity2 should have a tag with the same id as the entity1 and the value is dynamically matched\n  * `VALUE_EQUALS`- compares the tag of entity1 with the tag of entity2 attending to the configured rule and returns true if it does match\n  * `VALUE_NOT_EQUALS`- compares the tag of entity1 with the tag of entity2 attending to the configured rule and returns true if it does not match","enum":["TAG_EQUALS","VALUE_EQUALS","VALUE_NOT_EQUALS"],"type":"string","xml":{"name":"ToolkitOperatorType"},"title":"ToolkitOperatorType"}}}}
```

## The ToolkitPredicate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolkitPredicateConnector object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"}}}}
```

## The ToolkitPredicateDecisionDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolkitPredicatesDecisionDetail object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitPredicatesDecisionDetail":{"properties":{"connector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicateDecisionDetail"},"type":"array"}},"required":["connector","predicates"],"title":"ToolkitPredicatesDecisionDetail","description":"ToolkitPredicatesDecisionDetail"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicateDecisionDetail":{"properties":{"evaluationResult":{"type":"boolean"},"originalValue":{"items":{"type":"string"},"type":"array"},"predicate":{"$ref":"#/components/schemas/ToolkitPredicate"},"transformedValue":{"items":{"type":"string"},"type":"array"}},"required":["originalValue","transformedValue","evaluationResult","predicate"],"title":"ToolkitPredicateDecisionDetail","description":"ToolkitPredicateDecisionDetail"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolkitRating object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRating":{"allOf":[{"$ref":"#/components/schemas/ToolkitRatingForModification"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"description":"The id of the toolkit rating","type":"string"}},"required":["id"],"type":"object","xml":{"name":"ToolkitRating"},"title":"ToolkitRating","description":"ToolkitRating"},"ToolkitRatingForModification":{"allOf":[{"$ref":"#/components/schemas/ToolkitRatingForCreation"}],"properties":{"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ToolkitRatingForModification"},"title":"ToolkitRatingForModification","description":"ToolkitRatingForModification"},"ToolkitRatingForCreation":{"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"}},"required":["name","nameLocalized","active","maxPenalty"],"type":"object","xml":{"name":"ToolkitRatingForCreation"},"title":"ToolkitRatingForCreation","description":"ToolkitRatingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"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"}}}}
```

## The ToolkitRatingForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRatingForCreation":{"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"}},"required":["name","nameLocalized","active","maxPenalty"],"type":"object","xml":{"name":"ToolkitRatingForCreation"},"title":"ToolkitRatingForCreation","description":"ToolkitRatingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"}}}}
```

## The ToolkitRatingForModification object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRatingForModification":{"allOf":[{"$ref":"#/components/schemas/ToolkitRatingForCreation"}],"properties":{"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ToolkitRatingForModification"},"title":"ToolkitRatingForModification","description":"ToolkitRatingForModification"},"ToolkitRatingForCreation":{"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"}},"required":["name","nameLocalized","active","maxPenalty"],"type":"object","xml":{"name":"ToolkitRatingForCreation"},"title":"ToolkitRatingForCreation","description":"ToolkitRatingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"}}}}
```

## The ToolkitRatingTransporter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRatingTransporter":{"properties":{"ratings":{"items":{"$ref":"#/components/schemas/ToolkitRating"},"type":"array"},"total":{"description":"Total number of entities found for this query","type":"integer"}},"required":["ratings","total"],"type":"object","xml":{"name":"ToolkitRatingTransporter"},"title":"ToolkitRatingTransporter","description":"ToolkitRatingTransporter"},"ToolkitRating":{"allOf":[{"$ref":"#/components/schemas/ToolkitRatingForModification"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"description":"The id of the toolkit rating","type":"string"}},"required":["id"],"type":"object","xml":{"name":"ToolkitRating"},"title":"ToolkitRating","description":"ToolkitRating"},"ToolkitRatingForModification":{"allOf":[{"$ref":"#/components/schemas/ToolkitRatingForCreation"}],"properties":{"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ToolkitRatingForModification"},"title":"ToolkitRatingForModification","description":"ToolkitRatingForModification"},"ToolkitRatingForCreation":{"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"default":false,"description":"Indicates whether this fence is active or not","type":"boolean"},"comparisonRule":{"$ref":"#/components/schemas/ToolkitComparisonRule"},"description":{"description":"The description of this rating","type":"string"},"entity1":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"entity2":{"$ref":"#/components/schemas/ToolkitAllowedEntities","deprecated":true,"description":"This field is obsolete, was replaced by the entity fields at predicate level."},"maxPenalty":{"description":"The maximum penalty this rating can have","type":"integer"},"name":{"description":"The name of the rating","type":"string"},"rule":{"$ref":"#/components/schemas/ToolkitRule"}},"required":["name","nameLocalized","active","maxPenalty"],"type":"object","xml":{"name":"ToolkitRatingForCreation"},"title":"ToolkitRatingForCreation","description":"ToolkitRatingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ToolkitComparisonRule":{"description":"The rule, comparing the left and right path values, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitComparisonPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitComparisonRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitComparisonPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entityOperator":{"$ref":"#/components/schemas/ToolkitRuleComparisonOperatorType"},"leftEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity2 property"},"leftPropertyPath":{"minLength":1,"type":"string"},"leftTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"leftTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"},"rightEntity":{"$ref":"#/components/schemas/ToolkitAllowedEntities","description":"The entity that is used for the right side of the comparison - overrides the entity1 property"},"rightPropertyPath":{"minLength":1,"type":"string"},"rightTransformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"rightTransformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["rightPropertyPath","leftPropertyPath","entityOperator","leftEntity","rightEntity"],"type":"object","xml":{"name":"ToolkitComparisonPredicate"},"title":"ToolkitComparisonPredicate"},"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"},"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"}}}}
```

## The ToolkitRule object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRule":{"description":"The rule, containing the left predicates and the right predicates, that will be evaluated applying a RuleOperator","properties":{"evaluationScope":{"$ref":"#/components/schemas/ToolkitRuleScope"},"leftPart":{"$ref":"#/components/schemas/ToolkitRulePart"},"operator":{"$ref":"#/components/schemas/ToolkitRuleOperatorType"},"rightPart":{"$ref":"#/components/schemas/ToolkitRulePart"}},"required":["operator","leftPart","rightPart","evaluationScope"],"type":"object","xml":{"name":"ToolkitRule"},"title":"ToolkitRule"},"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"},"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"},"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"}}}}
```

## The ToolkitRuleComparePropertiesOperatorResultExplanation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRuleComparePropertiesOperatorResultExplanation":{"enum":["ALL_PREDICATES_MET","NOT_ALL_PREDICATES_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleComparePropertiesOperatorResultExplanation","description":"ToolkitRuleComparePropertiesOperatorResultExplanation"}}}}
```

## The ToolkitRuleComparisonOperatorType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRuleComparisonOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["NO_MATCHES","ALL_MATCHES","LEFT_CONTAINS_RIGHT","RIGHT_CONTAINS_LEFT"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleComparisonOperatorType"}}}}
```

## The ToolkitRuleOperatorResultExplanation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRuleOperatorResultExplanation":{"enum":["SKIPPED","BOTH_CONDITIONS_MET","ONLY_FIRST_CONDITION_MET","ONLY_SECOND_CONDITION_MET","SKIPPED_BECAUSE_OF_ERROR"],"title":"ToolkitRuleOperatorResultExplanation","description":"ToolkitRuleOperatorResultExplanation"}}}}
```

## The ToolkitRuleOperatorType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRuleOperatorType":{"description":"The type of the rule operator applied to the results of evaluating the left predicates and the right predicates","enum":["EQUALS"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitRuleOperatorType"}}}}
```

## The ToolkitRulePart object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRulePart":{"additionalProperties":false,"description":"One half of the rule, containing either the left or right predicates and booleanOperator.","properties":{"predicateConnector":{"$ref":"#/components/schemas/ToolkitPredicateConnector"},"predicates":{"items":{"$ref":"#/components/schemas/ToolkitPredicate"},"maxItems":100,"minItems":1,"type":"array"}},"required":["predicates"],"type":"object","xml":{"name":"ToolkitRulePart"},"title":"ToolkitRulePart"},"ToolkitPredicateConnector":{"description":"The allowed operators for connecting multiple predicates","enum":["OR","AND"],"type":"string","xml":{"name":"ToolkitPredicateConnector"},"title":"ToolkitPredicateConnector"},"ToolkitPredicate":{"description":"The predicate for a Toolkit V2 Fence that defines how conditions are constructed","properties":{"entity":{"$ref":"#/components/schemas/ToolkitAllowedEntities"},"entityOperator":{"$ref":"#/components/schemas/ToolkitEntityOperatorType"},"expectedValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"propertyPath":{"minLength":1,"type":"string"},"transformation":{"$ref":"#/components/schemas/ToolkitTransformationType"},"transformationArgs":{"items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"maxItems":100,"type":"array"}},"required":["propertyPath","entityOperator","entity"],"type":"object","xml":{"name":"ToolkitPredicate"},"title":"ToolkitPredicate"},"ToolkitAllowedEntities":{"description":"The entities that can be compared by the toolkit fence or rating\n  * `ORDER`\n  * `FACILITY`\n  * `CARRIERCONNECTION`\n  * `LISTING`\n  * `ORDERING_FACILITY` - left side only\n  * `ORDERING_FACILITY_GROUPS` - left side only","enum":["ORDER","FACILITY","CARRIERCONNECTION","LISTING","ORDERING_FACILITY","ORDERING_FACILITY_GROUPS"],"type":"string","xml":{"name":"ToolkitAllowedEntities"},"title":"ToolkitAllowedEntities"},"ToolkitEntityOperatorType":{"description":"The possible operator types that can be used on given entities","enum":["VALUE_EQUALS","VALUE_NOT_EQUALS","ANY_VALUE_EQUALS","ANY_VALUE_GREATER_EQUALS","ANY_VALUE_GREATER_THAN","ANY_VALUE_LESS_EQUALS","ANY_VALUE_LESS_THAN","ANY_VALUE_CONTAINS","ANY_VALUE_NOT_CONTAINS","EVERY_VALUE_EQUALS","EVERY_VALUE_GREATER_EQUALS","EVERY_VALUE_GREATER_THAN","EVERY_VALUE_LESS_EQUALS","EVERY_VALUE_LESS_THAN","EVERY_VALUE_CONTAINS","EVERY_VALUE_NOT_CONTAINS","NO_VALUE_EQUALS","NO_VALUE_GREATER_EQUALS","NO_VALUE_GREATER_THAN","NO_VALUE_LESS_EQUALS","NO_VALUE_LESS_THAN","NO_VALUE_CONTAINS","NO_VALUE_NOT_CONTAINS","VALUE_CONTAINS","VALUE_NOT_CONTAINS","GREATER_THAN","GREATER_EQUALS","LESS_THAN","LESS_EQUALS"],"type":"string","xml":{"name":"ToolkitEntityOperatorType"},"title":"ToolkitEntityOperatorType"},"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The ToolkitRuleScope object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitRuleScope":{"enum":["WHOLE_ENTITY","LINE_ITEM"],"type":"string","xml":{"name":"ToolkitRuleScope"},"title":"ToolkitRuleScope","description":"ToolkitRuleScope"}}}}
```

## The ToolkitTransformationType object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ToolkitTransformationType":{"description":"The transformations available to apply on the entity property value before a predicate is evaluated","enum":["SUBSTRING","COUNT","SUM","LAST"],"type":"string","xml":{"name":"ToolkitTransformationType"},"title":"ToolkitTransformationType"}}}}
```

## The TrackingInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformation":{"properties":{"carrierRef":{"description":"Reference to the connected carrier","minLength":1,"type":"string"},"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status of the latest tracking information event status."},"carrierStatusSet":{"description":"Creation timestamp of the latest tracking information event status.","format":"date-time","type":"string"},"created":{"description":"Creation date of this tracking information","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the connected facility ref via the connected shipping information","type":"string"},"id":{"description":"Unique identifier of this tracking information","type":"string"},"labelRef":{"description":"Reference to the connected label","minLength":1,"type":"string"},"labelUrl":{"description":"The URL to the label for this tracking information.","minLength":1,"type":"string"},"lastModified":{"description":"Last modification date of this tracking information","format":"date-time","type":"string"},"shippingInformationRef":{"description":"Reference to the connected shipping information","minLength":1,"type":"string"},"status":{"description":"Status of the tracking information entity. Will either be set by the workflow or calculated from the event history.","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE"],"type":"string"},"trackingHistory":{"description":"The tracking history of the tracking information. Most recent one is defined by the statusSet timestamp, then the internal id.","items":{"$ref":"#/components/schemas/TrackingInformationTrackingEvent"},"maxItems":100,"minItems":1,"type":"array"},"trackingNumber":{"description":"Tracking number of the connected label","minLength":1,"type":"string"},"trackingStatus":{"description":"Latest tracking information event status. Based on the found tracking event history.","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"trackingStatusSet":{"description":"Creation timestamp of the latest tracking information event.","format":"date-time","type":"string"},"trackingUrl":{"description":"Url to the tracking page of the given carrier and tracking number","minLength":1,"type":"string"},"type":{"description":"Type of this tracking information","enum":["SEND","RETURN"],"type":"string"},"version":{"description":"Version number of this tracking information","type":"integer"}},"required":["type","carrierRef","shippingInformationRef","trackingNumber","trackingUrl","labelUrl","trackingHistory","id","created","lastModified","version","status","trackingStatus","trackingStatusSet","carrierStatus","facilityRef"],"title":"TrackingInformation","type":"object","description":"TrackingInformation"},"TrackingInformationTrackingEvent":{"properties":{"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status from the carrier before mapping to the internal status"},"carrierStatusSet":{"description":"Creation timestamp","format":"date-time","type":"string"},"id":{"description":"Unique identifier of this tracking history","type":"string"},"status":{"description":"Internal Status of this Tracking Information Event","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"statusSet":{"description":"Creation timestamp","format":"date-time","type":"string"}},"required":["status","statusSet","carrierStatus","id"],"title":"TrackingInformationTrackingEvent","type":"object","description":"TrackingInformationTrackingEvent"}}}}
```

## The TrackingInformationAddTrackingEventActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationAddTrackingEventActionParameter":{"properties":{"name":{"description":"Name of this action","type":"string"},"trackingEvents":{"description":"Events to add to the tracking information","items":{"$ref":"#/components/schemas/TrackingInformationTrackingEventForCreation"},"maxItems":20,"minItems":1,"type":"array"},"version":{"description":"Version of the tracking information to call the action upon","minimum":0,"type":"integer"}},"required":["name","version","trackingEvents"],"title":"TrackingInformationAddTrackingEventActionParameter","type":"object","description":"TrackingInformationAddTrackingEventActionParameter"},"TrackingInformationTrackingEventForCreation":{"properties":{"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status from the carrier before mapping to the internal status"},"carrierStatusSet":{"description":"Creation timestamp","format":"date-time","type":"string"},"status":{"description":"Internal Status of this Tracking Information Event","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"statusSet":{"description":"Creation timestamp","format":"date-time","type":"string"}},"required":["status","statusSet","carrierStatus"],"title":"TrackingInformationTrackingEventForCreation","type":"object","description":"TrackingInformationTrackingEventForCreation"}}}}
```

## The TrackingInformationForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationForCreation":{"properties":{"carrierRef":{"description":"Reference to the connected carrier","minLength":1,"type":"string"},"labelRef":{"description":"Reference to the connected label","minLength":1,"type":"string"},"labelUrl":{"description":"The URL to the label for this tracking information.","minLength":1,"type":"string"},"shippingInformationRef":{"description":"Reference to the connected shipping information","minLength":1,"type":"string"},"trackingHistory":{"description":"The tracking history of the tracking information. Most recent one is defined by the statusSet timestamp, then the internal id.","items":{"$ref":"#/components/schemas/TrackingInformationTrackingEventForCreation"},"maxItems":100,"minItems":1,"type":"array"},"trackingNumber":{"description":"Tracking number of the connected label","minLength":1,"type":"string"},"trackingUrl":{"description":"Url to the tracking page of the given carrier and tracking number","minLength":1,"type":"string"},"type":{"description":"Type of this tracking information","enum":["SEND","RETURN"],"type":"string"}},"required":["type","carrierRef","shippingInformationRef","trackingNumber","trackingUrl","labelUrl","trackingHistory"],"title":"TrackingInformationForCreation","type":"object","description":"TrackingInformationForCreation"},"TrackingInformationTrackingEventForCreation":{"properties":{"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status from the carrier before mapping to the internal status"},"carrierStatusSet":{"description":"Creation timestamp","format":"date-time","type":"string"},"status":{"description":"Internal Status of this Tracking Information Event","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"statusSet":{"description":"Creation timestamp","format":"date-time","type":"string"}},"required":["status","statusSet","carrierStatus"],"title":"TrackingInformationTrackingEventForCreation","type":"object","description":"TrackingInformationTrackingEventForCreation"}}}}
```

## The TrackingInformationListResponse object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationListResponse":{"properties":{"totalCount":{"description":"Total number of found tracking information for the given search parameters","type":"integer"},"trackingInformation":{"items":{"$ref":"#/components/schemas/TrackingInformation"},"type":"array"}},"required":["trackingInformation"],"title":"TrackingInformationListResponse","type":"object","description":"TrackingInformationListResponse"},"TrackingInformation":{"properties":{"carrierRef":{"description":"Reference to the connected carrier","minLength":1,"type":"string"},"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status of the latest tracking information event status."},"carrierStatusSet":{"description":"Creation timestamp of the latest tracking information event status.","format":"date-time","type":"string"},"created":{"description":"Creation date of this tracking information","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the connected facility ref via the connected shipping information","type":"string"},"id":{"description":"Unique identifier of this tracking information","type":"string"},"labelRef":{"description":"Reference to the connected label","minLength":1,"type":"string"},"labelUrl":{"description":"The URL to the label for this tracking information.","minLength":1,"type":"string"},"lastModified":{"description":"Last modification date of this tracking information","format":"date-time","type":"string"},"shippingInformationRef":{"description":"Reference to the connected shipping information","minLength":1,"type":"string"},"status":{"description":"Status of the tracking information entity. Will either be set by the workflow or calculated from the event history.","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE"],"type":"string"},"trackingHistory":{"description":"The tracking history of the tracking information. Most recent one is defined by the statusSet timestamp, then the internal id.","items":{"$ref":"#/components/schemas/TrackingInformationTrackingEvent"},"maxItems":100,"minItems":1,"type":"array"},"trackingNumber":{"description":"Tracking number of the connected label","minLength":1,"type":"string"},"trackingStatus":{"description":"Latest tracking information event status. Based on the found tracking event history.","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"trackingStatusSet":{"description":"Creation timestamp of the latest tracking information event.","format":"date-time","type":"string"},"trackingUrl":{"description":"Url to the tracking page of the given carrier and tracking number","minLength":1,"type":"string"},"type":{"description":"Type of this tracking information","enum":["SEND","RETURN"],"type":"string"},"version":{"description":"Version number of this tracking information","type":"integer"}},"required":["type","carrierRef","shippingInformationRef","trackingNumber","trackingUrl","labelUrl","trackingHistory","id","created","lastModified","version","status","trackingStatus","trackingStatusSet","carrierStatus","facilityRef"],"title":"TrackingInformation","type":"object","description":"TrackingInformation"},"TrackingInformationTrackingEvent":{"properties":{"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status from the carrier before mapping to the internal status"},"carrierStatusSet":{"description":"Creation timestamp","format":"date-time","type":"string"},"id":{"description":"Unique identifier of this tracking history","type":"string"},"status":{"description":"Internal Status of this Tracking Information Event","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"statusSet":{"description":"Creation timestamp","format":"date-time","type":"string"}},"required":["status","statusSet","carrierStatus","id"],"title":"TrackingInformationTrackingEvent","type":"object","description":"TrackingInformationTrackingEvent"}}}}
```

## The TrackingInformationPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationPaginatedResult":{"properties":{"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"},"trackingInformations":{"items":{"$ref":"#/components/schemas/TrackingInformation"},"type":"array"}},"required":["pageInfo","trackingInformations"],"title":"TrackingInformationPaginatedResult","type":"object","description":"TrackingInformationPaginatedResult"},"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"},"TrackingInformation":{"properties":{"carrierRef":{"description":"Reference to the connected carrier","minLength":1,"type":"string"},"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status of the latest tracking information event status."},"carrierStatusSet":{"description":"Creation timestamp of the latest tracking information event status.","format":"date-time","type":"string"},"created":{"description":"Creation date of this tracking information","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the connected facility ref via the connected shipping information","type":"string"},"id":{"description":"Unique identifier of this tracking information","type":"string"},"labelRef":{"description":"Reference to the connected label","minLength":1,"type":"string"},"labelUrl":{"description":"The URL to the label for this tracking information.","minLength":1,"type":"string"},"lastModified":{"description":"Last modification date of this tracking information","format":"date-time","type":"string"},"shippingInformationRef":{"description":"Reference to the connected shipping information","minLength":1,"type":"string"},"status":{"description":"Status of the tracking information entity. Will either be set by the workflow or calculated from the event history.","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE"],"type":"string"},"trackingHistory":{"description":"The tracking history of the tracking information. Most recent one is defined by the statusSet timestamp, then the internal id.","items":{"$ref":"#/components/schemas/TrackingInformationTrackingEvent"},"maxItems":100,"minItems":1,"type":"array"},"trackingNumber":{"description":"Tracking number of the connected label","minLength":1,"type":"string"},"trackingStatus":{"description":"Latest tracking information event status. Based on the found tracking event history.","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"trackingStatusSet":{"description":"Creation timestamp of the latest tracking information event.","format":"date-time","type":"string"},"trackingUrl":{"description":"Url to the tracking page of the given carrier and tracking number","minLength":1,"type":"string"},"type":{"description":"Type of this tracking information","enum":["SEND","RETURN"],"type":"string"},"version":{"description":"Version number of this tracking information","type":"integer"}},"required":["type","carrierRef","shippingInformationRef","trackingNumber","trackingUrl","labelUrl","trackingHistory","id","created","lastModified","version","status","trackingStatus","trackingStatusSet","carrierStatus","facilityRef"],"title":"TrackingInformation","type":"object","description":"TrackingInformation"},"TrackingInformationTrackingEvent":{"properties":{"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status from the carrier before mapping to the internal status"},"carrierStatusSet":{"description":"Creation timestamp","format":"date-time","type":"string"},"id":{"description":"Unique identifier of this tracking history","type":"string"},"status":{"description":"Internal Status of this Tracking Information Event","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"statusSet":{"description":"Creation timestamp","format":"date-time","type":"string"}},"required":["status","statusSet","carrierStatus","id"],"title":"TrackingInformationTrackingEvent","type":"object","description":"TrackingInformationTrackingEvent"}}}}
```

## The TrackingInformationRemoveTrackingEventsParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationRemoveTrackingEventsParameter":{"properties":{"name":{"description":"Name of this action","type":"string"},"trackingEventIds":{"description":"Ids of the tracking events that should be removed from the tracking information","items":{"type":"string"},"maxItems":20,"minItems":1,"type":"array"},"version":{"description":"Version of the tracking information to call the action upon","minimum":0,"type":"integer"}},"required":["name","version","trackingEventIds"],"title":"TrackingInformationRemoveTrackingEventsParameter","type":"object","description":"TrackingInformationRemoveTrackingEventsParameter"}}}}
```

## The TrackingInformationSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationSearchPayload":{"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/TrackingInformationSearchQuery"},"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/TrackingInformationSort"},"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":"TrackingInformationSearchPayload","type":"object","description":"TrackingInformationSearchPayload"},"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"},"TrackingInformationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/TrackingInformationSearchQuery"},"maxItems":500,"type":"array"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"labelRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by labelRef"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/TrackingInformationSearchQuery"},"maxItems":500,"type":"array"},"shippingInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shippingInformationRef"},"trackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by trackingNumber"}},"title":"TrackingInformationSearchQuery","type":"object","description":"TrackingInformationSearchQuery"},"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"},"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"},"TrackingInformationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"TrackingInformationSort","type":"object","description":"TrackingInformationSort"}}}}
```

## The TrackingInformationSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/TrackingInformationSearchQuery"},"maxItems":500,"type":"array"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"labelRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by labelRef"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"items":{"$ref":"#/components/schemas/TrackingInformationSearchQuery"},"maxItems":500,"type":"array"},"shippingInformationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shippingInformationRef"},"trackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by trackingNumber"}},"title":"TrackingInformationSearchQuery","type":"object","description":"TrackingInformationSearchQuery"},"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"},"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"}}}}
```

## The TrackingInformationSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"TrackingInformationSort","type":"object","description":"TrackingInformationSort"}}}}
```

## The TrackingInformationTrackingEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationTrackingEvent":{"properties":{"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status from the carrier before mapping to the internal status"},"carrierStatusSet":{"description":"Creation timestamp","format":"date-time","type":"string"},"id":{"description":"Unique identifier of this tracking history","type":"string"},"status":{"description":"Internal Status of this Tracking Information Event","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"statusSet":{"description":"Creation timestamp","format":"date-time","type":"string"}},"required":["status","statusSet","carrierStatus","id"],"title":"TrackingInformationTrackingEvent","type":"object","description":"TrackingInformationTrackingEvent"}}}}
```

## The TrackingInformationTrackingEventForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingInformationTrackingEventForCreation":{"properties":{"carrierStatus":{"additionalProperties":true,"anyOf":[{"type":"string"},{"type":"object"}],"description":"Status from the carrier before mapping to the internal status"},"carrierStatusSet":{"description":"Creation timestamp","format":"date-time","type":"string"},"status":{"description":"Internal Status of this Tracking Information Event","enum":["REGISTERED","ERROR","PICKED_UP","IN_DELIVERY","DELIVERED","DELIVERED_TO_RECIPIENT","DELIVERED_TO_NEIGHBOUR","DELIVERED_TO_PICK_UP_STATION","NOT_PICKED_UP","RETURN_TO_SENDER","LOST","DESTROYED","CANCELLED","UNKNOWN"],"type":"string"},"statusSet":{"description":"Creation timestamp","format":"date-time","type":"string"}},"required":["status","statusSet","carrierStatus"],"title":"TrackingInformationTrackingEventForCreation","type":"object","description":"TrackingInformationTrackingEventForCreation"}}}}
```

## The TrackingStatus object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"}}}}
```

## The Transfer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Transfer":{"properties":{"transferId":{"type":"string"},"transferType":{"enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["transferId","transferType"],"title":"Transfer","description":"Transfer"}}}}
```

## The TransferTimeLine object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"}}}}
```

## The TransitTimeConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TransitTimeConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"calculationStrategy":{"enum":["EARLIEST","LATEST"],"type":"string"},"id":{"type":"string"}},"required":["id","calculationStrategy"],"type":"object","title":"TransitTimeConfiguration","description":"TransitTimeConfiguration"},"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"}}}}
```

## The TransitTimeConfigurationForUpsert object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TransitTimeConfigurationForUpsert":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"calculationStrategy":{"enum":["EARLIEST","LATEST"],"type":"string"}},"required":["calculationStrategy"],"type":"object","title":"TransitTimeConfigurationForUpsert","description":"TransitTimeConfigurationForUpsert"},"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"}}}}
```

## The TransportDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TransportDetails":{"properties":{"vehicleWidthInMeters":{"type":"number"}},"type":"object","title":"TransportDetails","description":"TransportDetails"}}}}
```

## The TwoManHandlingDetails object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"TwoManHandlingDetails":{"properties":{"dimensions":{"$ref":"#/components/schemas/PackagingUnitDetailDimensions"},"ldmToWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The grams equivalent to 1 loading meter, converting between weight and loading meters.","type":"number"},"maxItemQuantity":{"description":"The maximum number of items that can fit in the packagingUnit.","type":"number"},"maxVolume":{"description":"The maximum volume in cubicle millimeters of the packagingUnit.","type":"number"},"maxWeight":{"description":"The maximum weight in grams that the packagingUnit can hold.","type":"number"},"packagingPricingDetails":{"$ref":"#/components/schemas/PackagingPricingDetails"},"pricingBasis":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingBasis"}],"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The basis used to determine which quantity of the packagingUnit is chargeable."},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitType"}],"description":"The type of the packagingUnit."},"volumeBufferInPercent":{"description":"The volume buffer in percent for the packagingUnit.","type":"number"},"volumetricWeightFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The volumetric weight factor for the packagingUnit.","type":"number"},"weightToVolumeFactor":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />The factor converting the weight of the packagingUnit to an equivalent volume.","type":"number"}},"required":["type","dimensions","maxWeight","packagingPricingDetails"],"title":"TwoManHandlingDetails","type":"object","description":"TwoManHandlingDetails"},"PackagingUnitDetailDimensions":{"properties":{"maxHeight":{"description":"The max height of the packagingUnit in millimeters.","type":"number"},"maxLength":{"description":"The max length of the packagingUnit in millimeters.","type":"number"},"maxWidth":{"description":"The max width of the packagingUnit in millimeters.","type":"number"}},"required":["maxHeight","maxLength","maxWidth"],"title":"PackagingUnitDetailDimensions","type":"object","description":"PackagingUnitDetailDimensions"},"PackagingPricingDetails":{"properties":{"costCoefficient":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitCostCoefficient"}],"description":"Cost coefficient for two-man handling"},"pricing":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricingByZone"},"maxItems":500,"type":"array"},"surchargesPerPackagingUnits":{"description":"The surcharge applied per packagingUnit.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge","RELATIVE_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailRelativeSurcharge","THRESHOLD_SURCHARGE_TYPE":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackagingUnitDetailRelativeSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailAbsoluteSurcharge"},{"$ref":"#/components/schemas/PackagingUnitDetailThresholdSurcharge"}]},"maxItems":500,"type":"array"}},"required":["pricing"],"title":"PackagingPricingDetails","type":"object","description":"PackagingPricingDetails"},"PackagingUnitCostCoefficient":{"properties":{"measurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string"},"value":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["value","measurementUnit"],"title":"PackagingUnitCostCoefficient","type":"object","description":"PackagingUnitCostCoefficient"},"PackagingUnitsMoney":{"properties":{"currency":{"description":"The ISO 4217 currency code, e.g. EUR for Euro.","type":"string"},"decimalPlaces":{"default":2,"description":"The number of decimal places used by the currency, e.g. 2 for Euro.","type":"number"},"value":{"description":"The monetary value in the smallest currency unit","type":"number"}},"required":["currency","value"],"title":"PackagingUnitsMoney","type":"object","description":"PackagingUnitsMoney"},"PackagingUnitDetailPricingByZone":{"properties":{"overflowFactor":{"$ref":"#/components/schemas/PackagingUnitDetailOverflowFactor"},"prices":{"items":{"$ref":"#/components/schemas/PackagingUnitDetailPricesByWeight"},"maxItems":500,"type":"array"},"zone":{"description":"The shipping zone for which the pricing applies. Please proivide the ISO 3166-2 Country Code, followed by a dash and the first digits of the postal code, e.g. DE-50 for Cologne, Germany.","type":"string"}},"required":["prices"],"title":"PackagingUnitDetailPricingByZone","type":"object","description":"PackagingUnitDetailPricingByZone"},"PackagingUnitDetailOverflowFactor":{"properties":{"factor":{"description":"The factor appliable when the overflow factor is exceeded","type":"number"},"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"}},"required":["price","factor"],"title":"PackagingUnitDetailOverflowFactor","type":"object","description":"PackagingUnitDetailOverflowFactor"},"PackagingUnitDetailPricesByWeight":{"properties":{"price":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"upperThreshold":{"description":"The weight threshold in grams up to which this price applies.","type":"number"}},"required":["price","upperThreshold"],"title":"PackagingUnitDetailPricesByWeight","type":"object","description":"PackagingUnitDetailPricesByWeight"},"PackagingUnitDetailRelativeSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"percentage":{"description":"The percentage of the surcharge.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is RELATIVE in this case.","enum":["RELATIVE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","percentage"],"title":"PackagingUnitDetailRelativeSurcharge","type":"object","description":"PackagingUnitDetailRelativeSurcharge"},"PackagingUnitSurchargeContext":{"properties":{"operator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitSurchargeContextTypes"}],"description":"The kind of context the values refer to."},"values":{"description":"The values the context is matched against.","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["type","values"],"title":"PackagingUnitSurchargeContext","type":"object","description":"PackagingUnitSurchargeContext"},"PackagingUnitSurchargeContextTypes":{"description":"The kind of context the values refer to.","enum":["CATEGORY","TAG_REFERENCE","TARGET_POSTALCODE","TARGET_COUNTRY"],"title":"PackagingUnitSurchargeContextTypes","type":"string"},"PackagingUnitDetailAbsoluteSurcharge":{"properties":{"amount":{"$ref":"#/components/schemas/PackagingUnitsMoney"},"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is ABSOLUTE in this case.","enum":["ABSOLUTE_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","amount"],"title":"PackagingUnitDetailAbsoluteSurcharge","type":"object","description":"PackagingUnitDetailAbsoluteSurcharge"},"PackagingUnitDetailThresholdSurcharge":{"properties":{"context":{"description":"Restricts the surcharge to the given contexts. If omitted, the surcharge always applies.","items":{"$ref":"#/components/schemas/PackagingUnitSurchargeContext"},"maxItems":500,"type":"array"},"minimumAmount":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitsMoney"}],"description":"The amount that is charged whenever the percentage part stays below it."},"percentage":{"description":"The percentage of the surcharge, charged whenever it exceeds the minimum amount.","type":"number"},"tenantSurchargeType":{"description":"The tenant specific identifier for the surcharge type.","type":"string"},"type":{"description":"The type of surcharge, which is THRESHOLD in this case.","enum":["THRESHOLD_SURCHARGE_TYPE"],"type":"string"}},"required":["tenantSurchargeType","type","minimumAmount","percentage"],"title":"PackagingUnitDetailThresholdSurcharge","type":"object","description":"PackagingUnitDetailThresholdSurcharge"},"PackagingUnitPricingBasis":{"properties":{"pricingQuantities":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","items":{"$ref":"#/components/schemas/PackagingUnitPricingQuantity"},"maxItems":3,"type":"array"},"pricingUnit":{"allOf":[{"$ref":"#/components/schemas/PackagingUnitPricingUnit"}],"description":"The unit the pricing quantities are converted to and priced in."}},"required":["pricingUnit","pricingQuantities"],"title":"PackagingUnitPricingBasis","type":"object","description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />PackagingUnitPricingBasis"},"PackagingUnitPricingQuantity":{"description":"The physical quantities compared, each converted to pricingUnit; the highest one determines the chargeable amount. At least one must be given.","enum":["WEIGHT","VOLUME","LOADING_METERS"],"title":"PackagingUnitPricingQuantity","type":"string"},"PackagingUnitPricingUnit":{"description":"The unit the pricing quantities are converted to and priced in.","enum":["GRAM","CUBIC_METER","LOADING_METER"],"title":"PackagingUnitPricingUnit","type":"string"},"PackagingUnitType":{"description":"The type of the packagingUnit.","enum":["PALLET","TWO_MAN_HANDLING","PARCEL","BULKY_GOODS","LONG_GOODS"],"title":"PackagingUnitType","type":"string"}}}}
```

## The UBSendCarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UBSendCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"UBSendCarrierConfiguration","type":"object","description":"UBSendCarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The UpcomingTimeTriggeredRerouteWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpcomingTimeTriggeredRerouteWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/UpcomingTimeTriggeredRerouteWebHookEventPayload"}},"required":["payload"],"type":"object","title":"UpcomingTimeTriggeredRerouteWebHookEvent","description":"UpcomingTimeTriggeredRerouteWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"UpcomingTimeTriggeredRerouteWebHookEventPayload":{"properties":{"facilityData":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"},"timeZone":{"type":"string"}},"required":["name","facilityRef","timeZone"]},"pickJobData":{"properties":{"created":{"format":"date-time","type":"string"},"pickJobRef":{"type":"string"},"shortId":{"type":"string"},"tenantOrderId":{"type":"string"}},"required":["pickJobRef","tenantOrderId","shortId","created"]},"processRef":{"type":"string"},"rerouteDate":{"format":"date-time","type":"string"}},"required":["processRef","pickJobData","facilityData","rerouteDate"],"title":"UpcomingTimeTriggeredRerouteWebHookEventPayload","description":"UpcomingTimeTriggeredRerouteWebHookEventPayload"}}}}
```

## The UpcomingTimeTriggeredRerouteWebHookEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpcomingTimeTriggeredRerouteWebHookEventPayload":{"properties":{"facilityData":{"properties":{"facilityRef":{"type":"string"},"name":{"type":"string"},"timeZone":{"type":"string"}},"required":["name","facilityRef","timeZone"]},"pickJobData":{"properties":{"created":{"format":"date-time","type":"string"},"pickJobRef":{"type":"string"},"shortId":{"type":"string"},"tenantOrderId":{"type":"string"}},"required":["pickJobRef","tenantOrderId","shortId","created"]},"processRef":{"type":"string"},"rerouteDate":{"format":"date-time","type":"string"}},"required":["processRef","pickJobData","facilityData","rerouteDate"],"title":"UpcomingTimeTriggeredRerouteWebHookEventPayload","description":"UpcomingTimeTriggeredRerouteWebHookEventPayload"}}}}
```

## The UpdateChannelByIdAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateChannelByIdAction":{"properties":{"channel":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"name":{"enum":["UPDATE_CHANNEL"],"type":"string"},"version":{"type":"number"}},"required":["name","channel","version"],"title":"UpdateChannelByIdAction","type":"object","description":"UpdateChannelByIdAction"},"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"}}}}
```

## The UpdateFacilityCoordinatesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateFacilityCoordinatesActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractFacilityActionsParameter"}],"description":"Update facility Coordinates.","properties":{"coordinates":{"$ref":"#/components/schemas/Coordinates"},"name":{"enum":["UPDATE_FACILITY_COORDINATES"],"type":"string"}},"required":["name","coordinates","version"],"title":"UpdateFacilityCoordinatesActionParameter"},"AbstractFacilityActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractFacilityActionsParameter","description":"AbstractFacilityActionsParameter"},"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"}}}}
```

## The UpdateGdprCleanupDateAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateGdprCleanupDateAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'UpdateGdprCleanupDateAction' to update the GDPR cleanup date of a process.","enum":["UpdateGdprCleanupDateAction"],"type":"string"},"gdprCleanupDate":{"description":"The date when the process and all connected entities should be cleaned up / anonymized.","format":"date","type":"string"}},"required":["action","gdprCleanupDate"],"type":"object"}],"description":"Action to set the GDPR cleanup date of a process.","title":"UpdateGdprCleanupDateAction","xml":{"name":"UpdateGdprCleanupDateAction"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"}}}}
```

## The UpdateGdprCleanupDateActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateGdprCleanupDateActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to set the GDPR cleanup date of a process.","properties":{"gdprCleanupDate":{"description":"The date when the process and all connected entities should be cleaned up / anonymized.","format":"date","type":"string"},"name":{"enum":["UPDATE_GDPR_CLEANUP_DATE"],"type":"string"}},"required":["name","version","gdprCleanupDate"],"title":"UpdateGdprCleanupDateActionParameter"},"AbstractProcessActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractProcessActionsParameter","description":"AbstractProcessActionsParameter"}}}}
```

## The UpdateHandoverLineItemRecordableAttributesActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateHandoverLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_HANDOVER_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdateHandoverLineItemRecordableAttributesActionEnum","description":"UpdateHandoverLineItemRecordableAttributesActionEnum"}}}}
```

## The UpdateHandoverLineItemRecordableAttributesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The UpdateLineItemOnPackingTargetContainer object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateLineItemOnPackingTargetContainer":{"additionalProperties":false,"description":"Action to a update a line item of a packing target container.","properties":{"action":{"description":"Use UpdateLineItemOnPackingTargetContainer to change a line item on an existing packing container","enum":["UpdateLineItemOnPackingTargetContainer"],"type":"string"},"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"}},"required":["action","lineItem"],"title":"UpdateLineItemOnPackingTargetContainer","type":"object","xml":{"name":"UpdateLineItemOnPackingTargetContainer"}},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["id","article","quantity"],"type":"object","title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The UpdatePackingTargetContainerLineItemAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdatePackingTargetContainerLineItemAction":{"additionalProperties":false,"description":"Action to update a packing target container of a line item.","properties":{"name":{"$ref":"#/components/schemas/UpdatePackingTargetContainerLineItemEnum"},"payload":{"additionalProperties":false,"properties":{"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"}},"required":["lineItem"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","payload","name"],"title":"UpdatePackingTargetContainerLineItemAction","type":"object"},"UpdatePackingTargetContainerLineItemEnum":{"enum":["UpdateLineItem"],"type":"string","title":"UpdatePackingTargetContainerLineItemEnum","description":"UpdatePackingTargetContainerLineItemEnum"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","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 item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}}}],"required":["id","article","quantity"],"type":"object","title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"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"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"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"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed 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":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/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 fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"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.\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, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. 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"},"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"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"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. Ensure that no authentication is needed 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"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$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"}}}}
```

## The UpdatePackingTargetContainerLineItemEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdatePackingTargetContainerLineItemEnum":{"enum":["UpdateLineItem"],"type":"string","title":"UpdatePackingTargetContainerLineItemEnum","description":"UpdatePackingTargetContainerLineItemEnum"}}}}
```

## The UpdatePackingTargetContainerLineItemRecordableAttributes object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdatePackingTargetContainerLineItemRecordableAttributes":{"additionalProperties":false,"description":"Action to a update the recordable attributes of the line items of a packing target container.","properties":{"action":{"description":"Use this action to update the recordable attributes of the line items of a packing target container","enum":["UpdatePackingTargetContainerLineItemRecordableAttributes"],"type":"string"},"recordableAttributeUpdates":{"items":{"$ref":"#/components/schemas/RecordableAttributeForUpdate"},"type":"array"}},"required":["action","recordableAttributeUpdates"],"title":"UpdatePackingTargetContainerLineItemRecordableAttributes","type":"object","xml":{"name":"UpdatePackingTargetContainerLineItemRecordableAttributes"}},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The UpdatePackingTargetContainerStorageLocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdatePackingTargetContainerStorageLocation":{"additionalProperties":false,"description":"Action to update the storageLocationRef of a packing target container.","properties":{"action":{"description":"Use this action to update the storageLocationRef of a packing target container","enum":["UpdatePackingTargetContainerStorageLocation"],"type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"},"version":{"description":"The version of the packing target container to be used in optimistic locking mechanisms.","type":"integer"}},"required":["action","version","storageLocationRef"],"title":"UpdatePackingTargetContainerStorageLocation","type":"object","xml":{"name":"UpdatePackingTargetContainerStorageLocation"}}}}}
```

## The UpdatePackLineItemRecordableAttributesActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdatePackLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_PACK_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdatePackLineItemRecordableAttributesActionEnum","description":"UpdatePackLineItemRecordableAttributesActionEnum"}}}}
```

## The UpdatePackLineItemRecordableAttributesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdatePackLineItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdatePackLineItemRecordableAttributesActionEnum"},"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":"UpdatePackLineItemRecordableAttributesActionParameter","type":"object","description":"UpdatePackLineItemRecordableAttributesActionParameter"},"UpdatePackLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_PACK_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdatePackLineItemRecordableAttributesActionEnum","description":"UpdatePackLineItemRecordableAttributesActionEnum"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The UpdateParcelItemRecordableAttributesActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateParcelItemRecordableAttributesActionEnum":{"enum":["UPDATE_PARCEL_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdateParcelItemRecordableAttributesActionEnum","description":"UpdateParcelItemRecordableAttributesActionEnum"}}}}
```

## The UpdateParcelItemRecordableAttributesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateParcelItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdateParcelItemRecordableAttributesActionEnum"},"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":"UpdateParcelItemRecordableAttributesActionParameter","type":"object","description":"UpdateParcelItemRecordableAttributesActionParameter"},"UpdateParcelItemRecordableAttributesActionEnum":{"enum":["UPDATE_PARCEL_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdateParcelItemRecordableAttributesActionEnum","description":"UpdateParcelItemRecordableAttributesActionEnum"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The UpdatePickLineItemRecordableAttributesActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdatePickLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_PICK_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdatePickLineItemRecordableAttributesActionEnum","description":"UpdatePickLineItemRecordableAttributesActionEnum"}}}}
```

## The UpdatePickLineItemRecordableAttributesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdatePickLineItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdatePickLineItemRecordableAttributesActionEnum"},"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":"UpdatePickLineItemRecordableAttributesActionParameter","type":"object","description":"UpdatePickLineItemRecordableAttributesActionParameter"},"UpdatePickLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_PICK_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdatePickLineItemRecordableAttributesActionEnum","description":"UpdatePickLineItemRecordableAttributesActionEnum"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The UpdateProcessDeletionDateActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateProcessDeletionDateActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to set the deletion date date of a process.","properties":{"deletionDate":{"description":"The date when the process must be deleted.","format":"date","type":"string"},"name":{"enum":["UPDATE_PROCESS_DELETION_DATE"],"type":"string"}},"required":["name","version","deletionDate"],"title":"UpdateProcessDeletionDateActionParameter"},"AbstractProcessActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractProcessActionsParameter","description":"AbstractProcessActionsParameter"}}}}
```

## The UpdateRefuseReasonParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateRefuseReasonParameter":{"additionalProperties":false,"properties":{"availableRefuseReasonForUpdate":{"$ref":"#/components/schemas/AvailableRefuseReasonForUpdate"},"handoverConfigurationVersion":{"type":"number"}},"required":["handoverConfigurationVersion","availableRefuseReasonForUpdate"],"type":"object","title":"UpdateRefuseReasonParameter","description":"UpdateRefuseReasonParameter"},"AvailableRefuseReasonForUpdate":{"additionalProperties":false,"properties":{"refusedReasonLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized reason"},"active":{"type":"boolean"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"number"}},"required":["active","refusedReasonLocalized","version"],"type":"object","title":"AvailableRefuseReasonForUpdate","description":"AvailableRefuseReasonForUpdate"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The UpdateServiceDataAvailableLineItemsActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateServiceDataAvailableLineItemsActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'UPDATE_SERVICE_DATA_AVAILABLE_LINE_ITEMS'","enum":["UPDATE_SERVICE_DATA_AVAILABLE_LINE_ITEMS"],"type":"string"},"serviceDataAvailableLineItemsUpdates":{"description":"availableLineItem Updates","items":{"$ref":"#/components/schemas/ServiceDataAvailableLineItemForUpdate"},"maxItems":50,"minItems":1,"type":"array"},"serviceDataVersion":{"description":"Version of the service data","minimum":0,"type":"integer"}},"required":["name","serviceDataAvailableLineItemsUpdates","serviceDataVersion"],"title":"UpdateServiceDataAvailableLineItemsActionParameter","type":"object","description":"UpdateServiceDataAvailableLineItemsActionParameter"},"ServiceDataAvailableLineItemForUpdate":{"properties":{"availableQuantity":{"description":"Available quantity of the items","minimum":0,"type":"integer"},"executedServiceJobData":{"description":"Updated history of service jobs that have processed this line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"id":{"description":"ID of the available line item to update","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":0,"type":"integer"}},"required":["id"],"title":"ServiceDataAvailableLineItemForUpdate","type":"object","description":"ServiceDataAvailableLineItemForUpdate"},"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"}}}}
```

## The UpdateServiceJobLineItemRecordableAttributesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateServiceJobLineItemRecordableAttributesActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'UPDATE_SERVICE_JOB_LINE_ITEM_RECORDABLE_ATTRIBUTES'","enum":["UPDATE_SERVICE_JOB_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string"},"recordableAttributeUpdates":{"items":{"$ref":"#/components/schemas/RecordableAttributeForUpdate"},"maxItems":50,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","minimum":0,"type":"integer"}},"required":["name","version","recordableAttributeUpdates"],"title":"UpdateServiceJobLineItemRecordableAttributesActionParameter","type":"object","description":"UpdateServiceJobLineItemRecordableAttributesActionParameter"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The UpdateShipmentLineItemRecordableAttributesActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateShipmentLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_SHIPMENT_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdateShipmentLineItemRecordableAttributesActionEnum","description":"UpdateShipmentLineItemRecordableAttributesActionEnum"}}}}
```

## The UpdateShipmentLineItemRecordableAttributesActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UpdateShipmentLineItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdateShipmentLineItemRecordableAttributesActionEnum"},"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":"UpdateShipmentLineItemRecordableAttributesActionParameter","type":"object","description":"UpdateShipmentLineItemRecordableAttributesActionParameter"},"UpdateShipmentLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_SHIPMENT_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdateShipmentLineItemRecordableAttributesActionEnum","description":"UpdateShipmentLineItemRecordableAttributesActionEnum"},"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"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"}}}}
```

## The User object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The UserActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserActionEnum":{"description":"The type of action to perform","enum":["ModifyUser"],"title":"UserActionEnum","type":"string"}}}}
```

## The UserAssignedFacilitiesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedFacilitiesFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"}},"title":"UserAssignedFacilitiesFilter","type":"object","description":"UserAssignedFacilitiesFilter"},"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"}}}}
```

## The UserAssignedFacilitiesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedFacilitiesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedFacilitiesListFilter","type":"object","description":"UserAssignedFacilitiesListFilter"},"UserAssignedFacilitiesFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"}},"title":"UserAssignedFacilitiesFilter","type":"object","description":"UserAssignedFacilitiesFilter"},"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"}}}}
```

## The UserAssignedFacility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"}}}}
```

## The UserAssignedFacilityForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedFacilityForCreation":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef"],"title":"UserAssignedFacilityForCreation","type":"object","description":"UserAssignedFacilityForCreation"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"}}}}
```

## The UserAssignedRolesContextContextTypesEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"}}}}
```

## The UserAssignedRolesContextFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesContextFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextFilter","type":"object","description":"UserAssignedRolesContextFilter"},"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The UserAssignedRolesContextLimitationsContextTypesEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"}}}}
```

## The UserAssignedRolesContextLimitationsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesContextLimitationsFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextLimitationsFilter","type":"object","description":"UserAssignedRolesContextLimitationsFilter"},"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The UserAssignedRolesContextLimitationsListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesContextLimitationsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextLimitationsListFilter","type":"object","description":"UserAssignedRolesContextLimitationsListFilter"},"UserAssignedRolesContextLimitationsFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextLimitationsFilter","type":"object","description":"UserAssignedRolesContextLimitationsFilter"},"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The UserAssignedRolesContextListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesContextListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextListFilter","type":"object","description":"UserAssignedRolesContextListFilter"},"UserAssignedRolesContextFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextFilter","type":"object","description":"UserAssignedRolesContextFilter"},"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"}}}}
```

## The UserAssignedRolesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesFilter":{"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextListFilter"}],"description":"Nested list search by context"},"contextLimitations":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsListFilter"}],"deprecated":true,"description":"Deprecated: Use context field instead"},"ref":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ref"}},"title":"UserAssignedRolesFilter","type":"object","description":"UserAssignedRolesFilter"},"UserAssignedRolesContextListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextListFilter","type":"object","description":"UserAssignedRolesContextListFilter"},"UserAssignedRolesContextFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextFilter","type":"object","description":"UserAssignedRolesContextFilter"},"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserAssignedRolesContextLimitationsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextLimitationsListFilter","type":"object","description":"UserAssignedRolesContextLimitationsListFilter"},"UserAssignedRolesContextLimitationsFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextLimitationsFilter","type":"object","description":"UserAssignedRolesContextLimitationsFilter"},"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"},"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"}}}}
```

## The UserAssignedRolesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesListFilter","type":"object","description":"UserAssignedRolesListFilter"},"UserAssignedRolesFilter":{"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextListFilter"}],"description":"Nested list search by context"},"contextLimitations":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsListFilter"}],"deprecated":true,"description":"Deprecated: Use context field instead"},"ref":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ref"}},"title":"UserAssignedRolesFilter","type":"object","description":"UserAssignedRolesFilter"},"UserAssignedRolesContextListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextListFilter","type":"object","description":"UserAssignedRolesContextListFilter"},"UserAssignedRolesContextFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextFilter","type":"object","description":"UserAssignedRolesContextFilter"},"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserAssignedRolesContextLimitationsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextLimitationsListFilter","type":"object","description":"UserAssignedRolesContextLimitationsListFilter"},"UserAssignedRolesContextLimitationsFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextLimitationsFilter","type":"object","description":"UserAssignedRolesContextLimitationsFilter"},"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"},"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"}}}}
```

## The UserAssignedRolesSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedRolesSort":{"properties":{"ref":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAssignedRolesSort","type":"object","description":"UserAssignedRolesSort"}}}}
```

## The UserAssignedZone object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"}}}}
```

## The UserAuthAuthenticationProviderTypeEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAuthAuthenticationProviderTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"}},"title":"UserAuthAuthenticationProviderTypeEnumFilter","type":"object","description":"UserAuthAuthenticationProviderTypeEnumFilter"}}}}
```

## The UserAuthenticationProviderSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAuthenticationProviderSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAuthenticationProviderSort","type":"object","description":"UserAuthenticationProviderSort"}}}}
```

## The UserAuthFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserAuthFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAuthAuthenticationProviderTypeEnumFilter"}],"description":"Search by type"}},"title":"UserAuthFilter","type":"object","description":"UserAuthFilter"},"UserAuthAuthenticationProviderTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"}},"title":"UserAuthAuthenticationProviderTypeEnumFilter","type":"object","description":"UserAuthAuthenticationProviderTypeEnumFilter"}}}}
```

## The UserCreatedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserCreatedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/User"}},"required":["payload"],"type":"object","title":"UserCreatedWebHookEvent","description":"UserCreatedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The UserCustomClaimsFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserCustomClaimsFilter":{"properties":{"roles":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesListFilter"}],"description":"Nested list search by roles"}},"title":"UserCustomClaimsFilter","type":"object","description":"UserCustomClaimsFilter"},"UserCustomClaimsRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserCustomClaimsRolesListFilter","type":"object","description":"UserCustomClaimsRolesListFilter"},"UserCustomClaimsRolesFilter":{"properties":{"facilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilities"},"name":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesUserRoleNamesEnumFilter"}],"description":"Search by name"}},"title":"UserCustomClaimsRolesFilter","type":"object","description":"UserCustomClaimsRolesFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserCustomClaimsRolesUserRoleNamesEnumFilter":{"properties":{"eq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"in":{"description":"Search by name","items":{"enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"}},"title":"UserCustomClaimsRolesUserRoleNamesEnumFilter","type":"object","description":"UserCustomClaimsRolesUserRoleNamesEnumFilter"}}}}
```

## The UserCustomClaimsRolesFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserCustomClaimsRolesFilter":{"properties":{"facilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilities"},"name":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesUserRoleNamesEnumFilter"}],"description":"Search by name"}},"title":"UserCustomClaimsRolesFilter","type":"object","description":"UserCustomClaimsRolesFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserCustomClaimsRolesUserRoleNamesEnumFilter":{"properties":{"eq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"in":{"description":"Search by name","items":{"enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"}},"title":"UserCustomClaimsRolesUserRoleNamesEnumFilter","type":"object","description":"UserCustomClaimsRolesUserRoleNamesEnumFilter"}}}}
```

## The UserCustomClaimsRolesListFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserCustomClaimsRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserCustomClaimsRolesListFilter","type":"object","description":"UserCustomClaimsRolesListFilter"},"UserCustomClaimsRolesFilter":{"properties":{"facilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilities"},"name":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesUserRoleNamesEnumFilter"}],"description":"Search by name"}},"title":"UserCustomClaimsRolesFilter","type":"object","description":"UserCustomClaimsRolesFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserCustomClaimsRolesUserRoleNamesEnumFilter":{"properties":{"eq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"in":{"description":"Search by name","items":{"enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"}},"title":"UserCustomClaimsRolesUserRoleNamesEnumFilter","type":"object","description":"UserCustomClaimsRolesUserRoleNamesEnumFilter"}}}}
```

## The UserCustomClaimsRolesUserRoleNamesEnumFilter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserCustomClaimsRolesUserRoleNamesEnumFilter":{"properties":{"eq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"in":{"description":"Search by name","items":{"enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"}},"title":"UserCustomClaimsRolesUserRoleNamesEnumFilter","type":"object","description":"UserCustomClaimsRolesUserRoleNamesEnumFilter"}}}}
```

## The UserDeletedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserDeletedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/User"}},"required":["payload"],"type":"object","title":"UserDeletedWebHookEvent","description":"UserDeletedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The UserForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserForCreation":{"properties":{"assignedFacilities":{"description":"The assigned facilities of the user","items":{"$ref":"#/components/schemas/UserAssignedFacilityForCreation"},"type":"array"},"assignedRoles":{"description":"The roles which are assigned to the user","items":{"$ref":"#/components/schemas/AssignedRoles"},"maxItems":10,"minItems":1,"type":"array"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"email":{"description":"The email of the user","type":"string"},"firstname":{"description":"The first name of the user","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"password":{"description":"The password of the user","type":"string"},"roles":{"deprecated":true,"description":"Deprecated: Use assignedRoles instead","items":{"$ref":"#/components/schemas/UserRole"},"maxItems":1,"minItems":1,"type":"array"},"username":{"description":"The username of the user","type":"string"}},"required":["firstname","lastname","username","password"],"title":"UserForCreation","type":"object","description":"UserForCreation"},"UserAssignedFacilityForCreation":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef"],"title":"UserAssignedFacilityForCreation","type":"object","description":"UserAssignedFacilityForCreation"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The UserModificationHistory object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"}}}}
```

## The UserPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserPaginatedResult":{"properties":{"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"},"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"required":["pageInfo","users"],"title":"UserPaginatedResult","type":"object","description":"UserPaginatedResult"},"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"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The UserPasswordResetAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserPasswordResetAction":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/UserPublicActionEnum"}],"description":"The action to perform"},"username":{"description":"The username to request password reset for","type":"string"}},"required":["name","username"],"title":"UserPasswordResetAction","type":"object","description":"UserPasswordResetAction"},"UserPublicActionEnum":{"description":"The action to perform","enum":["REQUEST_PASSWORD_RESET"],"title":"UserPublicActionEnum","type":"string"}}}}
```

## The UserPatchActions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserPatchActions":{"properties":{"actions":{"description":"The actions to perform","items":{"$ref":"#/components/schemas/ModifyUserAction"},"maxItems":5,"type":"array"},"version":{"description":"The version of the user to modify","type":"number"}},"required":["actions","version"],"title":"UserPatchActions","type":"object","description":"UserPatchActions"},"ModifyUserAction":{"properties":{"action":{"allOf":[{"$ref":"#/components/schemas/UserActionEnum"}],"description":"The type of action to perform"},"assignedFacilities":{"deprecated":true,"description":"Deprecated: Use assignedRoles with contextLimitation of type FACILITY instead","items":{"$ref":"#/components/schemas/UserAssignedFacilityForCreation"},"type":"array"},"assignedRoles":{"description":"The new roles of the user","items":{"$ref":"#/components/schemas/AssignedRoles"},"maxItems":100,"type":"array"},"customAttributes":{"description":"The new custom attributes of the user","nullable":true,"type":"object"},"email":{"description":"The changed email of the user","type":"string"},"firstname":{"description":"The new firstname of the user","type":"string"},"lastname":{"description":"The new lastname of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"password":{"description":"The new password of the user","type":"string"},"roles":{"deprecated":true,"description":"Deprecated: Use assignedRoles instead","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["action"],"title":"ModifyUserAction","type":"object","description":"ModifyUserAction"},"UserActionEnum":{"description":"The type of action to perform","enum":["ModifyUser"],"title":"UserActionEnum","type":"string"},"UserAssignedFacilityForCreation":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef"],"title":"UserAssignedFacilityForCreation","type":"object","description":"UserAssignedFacilityForCreation"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The UserPublicActionEnum object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserPublicActionEnum":{"description":"The action to perform","enum":["REQUEST_PASSWORD_RESET"],"title":"UserPublicActionEnum","type":"string"}}}}
```

## The UserRole object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The UserRoleNames object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserRoleNames":{"description":"All available user roles","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string","xml":{"name":"UserRoleNames"},"title":"UserRoleNames"}}}}
```

## The UserRoleWithPermissions object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserRoleWithPermissions":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE"],"type":"string"},"type":"array"}},"required":["name"],"title":"UserRoleWithPermissions","type":"object","description":"UserRoleWithPermissions"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## The UserSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserSearchPayload":{"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/UserSearchQuery"},"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/UserSort"},"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":"UserSearchPayload","type":"object","description":"UserSearchPayload"},"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"},"UserSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/UserSearchQuery"},"maxItems":500,"type":"array"},"assignedFacilities":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesListFilter"}],"description":"Nested list search by assignedFacilities"},"assignedRoles":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesListFilter"}],"description":"Nested list search by assignedRoles"},"auth":{"allOf":[{"$ref":"#/components/schemas/UserAuthFilter"}],"description":"Nested search by auth"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsFilter"}],"description":"Nested search by customClaims"},"facilityLimitations":{"allOf":[{"$ref":"#/components/schemas/StringListExistsFilter"}],"description":"Search by facilityLimitations"},"firstname":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstname"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"lastname":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastname"},"or":{"items":{"$ref":"#/components/schemas/UserSearchQuery"},"maxItems":500,"type":"array"},"username":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by username"}},"title":"UserSearchQuery","type":"object","description":"UserSearchQuery"},"UserAssignedFacilitiesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedFacilitiesListFilter","type":"object","description":"UserAssignedFacilitiesListFilter"},"UserAssignedFacilitiesFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"}},"title":"UserAssignedFacilitiesFilter","type":"object","description":"UserAssignedFacilitiesFilter"},"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"},"UserAssignedRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesListFilter","type":"object","description":"UserAssignedRolesListFilter"},"UserAssignedRolesFilter":{"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextListFilter"}],"description":"Nested list search by context"},"contextLimitations":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsListFilter"}],"deprecated":true,"description":"Deprecated: Use context field instead"},"ref":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ref"}},"title":"UserAssignedRolesFilter","type":"object","description":"UserAssignedRolesFilter"},"UserAssignedRolesContextListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextListFilter","type":"object","description":"UserAssignedRolesContextListFilter"},"UserAssignedRolesContextFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextFilter","type":"object","description":"UserAssignedRolesContextFilter"},"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserAssignedRolesContextLimitationsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextLimitationsListFilter","type":"object","description":"UserAssignedRolesContextLimitationsListFilter"},"UserAssignedRolesContextLimitationsFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextLimitationsFilter","type":"object","description":"UserAssignedRolesContextLimitationsFilter"},"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"},"UserAuthFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAuthAuthenticationProviderTypeEnumFilter"}],"description":"Search by type"}},"title":"UserAuthFilter","type":"object","description":"UserAuthFilter"},"UserAuthAuthenticationProviderTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"}},"title":"UserAuthAuthenticationProviderTypeEnumFilter","type":"object","description":"UserAuthAuthenticationProviderTypeEnumFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"UserCustomClaimsFilter":{"properties":{"roles":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesListFilter"}],"description":"Nested list search by roles"}},"title":"UserCustomClaimsFilter","type":"object","description":"UserCustomClaimsFilter"},"UserCustomClaimsRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserCustomClaimsRolesListFilter","type":"object","description":"UserCustomClaimsRolesListFilter"},"UserCustomClaimsRolesFilter":{"properties":{"facilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilities"},"name":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesUserRoleNamesEnumFilter"}],"description":"Search by name"}},"title":"UserCustomClaimsRolesFilter","type":"object","description":"UserCustomClaimsRolesFilter"},"UserCustomClaimsRolesUserRoleNamesEnumFilter":{"properties":{"eq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"in":{"description":"Search by name","items":{"enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"}},"title":"UserCustomClaimsRolesUserRoleNamesEnumFilter","type":"object","description":"UserCustomClaimsRolesUserRoleNamesEnumFilter"},"StringListExistsFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"},"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"StringListExistsFilter","type":"object","description":"StringListExistsFilter"},"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"},"UserSort":{"properties":{"assignedRoles":{"$ref":"#/components/schemas/UserAssignedRolesSort"},"authenticationProvider":{"$ref":"#/components/schemas/UserAuthenticationProviderSort"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"firstname":{"enum":["ASC","DESC"],"type":"string"},"lastLogin":{"enum":["ASC","DESC"],"type":"string"},"lastname":{"enum":["ASC","DESC"],"type":"string"},"username":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserSort","type":"object","description":"UserSort"},"UserAssignedRolesSort":{"properties":{"ref":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAssignedRolesSort","type":"object","description":"UserAssignedRolesSort"},"UserAuthenticationProviderSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAuthenticationProviderSort","type":"object","description":"UserAuthenticationProviderSort"}}}}
```

## The UserSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/UserSearchQuery"},"maxItems":500,"type":"array"},"assignedFacilities":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesListFilter"}],"description":"Nested list search by assignedFacilities"},"assignedRoles":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesListFilter"}],"description":"Nested list search by assignedRoles"},"auth":{"allOf":[{"$ref":"#/components/schemas/UserAuthFilter"}],"description":"Nested search by auth"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsFilter"}],"description":"Nested search by customClaims"},"facilityLimitations":{"allOf":[{"$ref":"#/components/schemas/StringListExistsFilter"}],"description":"Search by facilityLimitations"},"firstname":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstname"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"lastname":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastname"},"or":{"items":{"$ref":"#/components/schemas/UserSearchQuery"},"maxItems":500,"type":"array"},"username":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by username"}},"title":"UserSearchQuery","type":"object","description":"UserSearchQuery"},"UserAssignedFacilitiesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedFacilitiesListFilter","type":"object","description":"UserAssignedFacilitiesListFilter"},"UserAssignedFacilitiesFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"}},"title":"UserAssignedFacilitiesFilter","type":"object","description":"UserAssignedFacilitiesFilter"},"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"},"UserAssignedRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesListFilter","type":"object","description":"UserAssignedRolesListFilter"},"UserAssignedRolesFilter":{"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextListFilter"}],"description":"Nested list search by context"},"contextLimitations":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsListFilter"}],"deprecated":true,"description":"Deprecated: Use context field instead"},"ref":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ref"}},"title":"UserAssignedRolesFilter","type":"object","description":"UserAssignedRolesFilter"},"UserAssignedRolesContextListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextListFilter","type":"object","description":"UserAssignedRolesContextListFilter"},"UserAssignedRolesContextFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextFilter","type":"object","description":"UserAssignedRolesContextFilter"},"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserAssignedRolesContextLimitationsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextLimitationsListFilter","type":"object","description":"UserAssignedRolesContextLimitationsListFilter"},"UserAssignedRolesContextLimitationsFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextLimitationsFilter","type":"object","description":"UserAssignedRolesContextLimitationsFilter"},"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"},"UserAuthFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAuthAuthenticationProviderTypeEnumFilter"}],"description":"Search by type"}},"title":"UserAuthFilter","type":"object","description":"UserAuthFilter"},"UserAuthAuthenticationProviderTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"}},"title":"UserAuthAuthenticationProviderTypeEnumFilter","type":"object","description":"UserAuthAuthenticationProviderTypeEnumFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"UserCustomClaimsFilter":{"properties":{"roles":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesListFilter"}],"description":"Nested list search by roles"}},"title":"UserCustomClaimsFilter","type":"object","description":"UserCustomClaimsFilter"},"UserCustomClaimsRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserCustomClaimsRolesListFilter","type":"object","description":"UserCustomClaimsRolesListFilter"},"UserCustomClaimsRolesFilter":{"properties":{"facilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilities"},"name":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesUserRoleNamesEnumFilter"}],"description":"Search by name"}},"title":"UserCustomClaimsRolesFilter","type":"object","description":"UserCustomClaimsRolesFilter"},"UserCustomClaimsRolesUserRoleNamesEnumFilter":{"properties":{"eq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"in":{"description":"Search by name","items":{"enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"}},"title":"UserCustomClaimsRolesUserRoleNamesEnumFilter","type":"object","description":"UserCustomClaimsRolesUserRoleNamesEnumFilter"},"StringListExistsFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"},"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"StringListExistsFilter","type":"object","description":"StringListExistsFilter"},"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"}}}}
```

## The UserSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserSort":{"properties":{"assignedRoles":{"$ref":"#/components/schemas/UserAssignedRolesSort"},"authenticationProvider":{"$ref":"#/components/schemas/UserAuthenticationProviderSort"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"firstname":{"enum":["ASC","DESC"],"type":"string"},"lastLogin":{"enum":["ASC","DESC"],"type":"string"},"lastname":{"enum":["ASC","DESC"],"type":"string"},"username":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserSort","type":"object","description":"UserSort"},"UserAssignedRolesSort":{"properties":{"ref":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAssignedRolesSort","type":"object","description":"UserAssignedRolesSort"},"UserAuthenticationProviderSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAuthenticationProviderSort","type":"object","description":"UserAuthenticationProviderSort"}}}}
```

## The UserUpdatedWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"UserUpdatedWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/User"}},"required":["payload"],"type":"object","title":"UserUpdatedWebHookEvent","description":"UserUpdatedWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The VceCarrierConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"VceCarrierConfiguration":{"properties":{"additionalWeightInPercent":{"description":"It is an amount of percentage for packaging weight which will be added to the calculated shipping weight","minimum":0,"type":"number"},"alternativeReturnAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative return address for this carrier"},"alternativeSendAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddress"}],"description":"Alternative send address for this carrier"},"carrierRef":{"description":"Reference to the carrier this configuration belongs to","type":"string"},"countryServiceMappings":{"description":"Country service mappings for this carrier configuration","items":{"$ref":"#/components/schemas/CarrierCountryServiceMapping"},"maxItems":100,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"defaultPickUpTime":{"allOf":[{"$ref":"#/components/schemas/CarrierPickUpTime"}],"description":"Default pick up time configuration for carriers supporting pick up scheduling, will be used to calculate the next possible pick up date"},"fallBackTrackAndTraceEmail":{"description":"EmailAddress used to receive track and trace information when no other emailaddress was provided","format":"email","minLength":1,"type":"string"},"id":{"description":"The id of the carrier configuration","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"mustBeWeighed":{"default":false,"description":"Indicates if the content of a parcel must be weighed before ordering a label","type":"boolean"},"nonDeliveryDaysPerCountryAndProvince":{"description":"Non-delivery days per country and province","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerCountryAndProvince"},"maxItems":500,"type":"array"},"returnLabel":{"default":false,"description":"When enabled, a return label will be created by creating a shipping label","type":"boolean"},"serviceUrl":{"description":"Service URL for this carrier configuration","type":"string"},"thresholdPriceValue":{"allOf":[{"$ref":"#/components/schemas/ThresholdPriceValue"}],"description":"Threshold price value for carrier selection"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["version","carrierRef","returnLabel"],"title":"VceCarrierConfiguration","type":"object","description":"VceCarrierConfiguration"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"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"},"maxItems":500,"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"},"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"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"CarrierCountryServiceMapping":{"properties":{"additionalShippingArticleAttributes":{"description":"Article Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingArticleAttribute"},"maxItems":20,"type":"array"},"additionalShippingAttributes":{"description":"Shipping Attributes that will be displayed in the client as additional. They are not mandatory but could benefit the process.","items":{"$ref":"#/components/schemas/AdditionalShippingAttribute"},"maxItems":30,"type":"array"},"carrierProductCategory":{"description":"Desired product class to choose when ordering a label","enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string"},"carrierServices":{"description":"Services which can be provided by the carrier","items":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string"},"maxItems":10,"type":"array"},"countAsTransitDayBefore":{"description":"Time before which this day counts as a transit day","type":"string"},"deliveryCosts":{"description":"Delivery costs for this mapping","items":{"$ref":"#/components/schemas/DeliveryCost"},"maxItems":1,"type":"array"},"destinationCountries":{"deprecated":true,"description":"deprecated - Use destinations instead.","items":{"type":"string"},"maxItems":250,"type":"array"},"destinations":{"description":"The destination regions this mapping should be applied to.","items":{"$ref":"#/components/schemas/RegionInformation"},"maxItems":250,"type":"array"},"id":{"description":"Unique identifier for a countryServiceMapping","type":"string"},"mandatoryShippingArticleAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingArticleAttribute"},"maxItems":20,"type":"array"},"mandatoryShippingAttributes":{"items":{"$ref":"#/components/schemas/MandatoryShippingAttribute"},"maxItems":30,"type":"array"},"mandatoryShippingItemAttributes":{"deprecated":true,"description":"Deprecated - use mandatoryShippingArticleAttributes instead","items":{"$ref":"#/components/schemas/MandatoryShippingItemAttribute"},"maxItems":30,"type":"array"},"products":{"description":"Array of products for the given mapping","items":{"type":"string"},"maxItems":50,"type":"array"},"source":{"allOf":[{"$ref":"#/components/schemas/RegionInformation"}],"description":"Source region for this mapping"},"sourceCountry":{"deprecated":true,"description":"deprecated - Use source instead.","type":"string"},"staticCCSMRef":{"description":"Reference to a static country service mapping","type":"string"},"transitTime":{"allOf":[{"$ref":"#/components/schemas/CarrierTransitTime"}],"description":"Transit time configuration for this mapping"}},"required":["id","source","destinations"],"title":"CarrierCountryServiceMapping","type":"object","description":"CarrierCountryServiceMapping"},"AdditionalShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"AdditionalShippingArticleAttribute","type":"object","description":"AdditionalShippingArticleAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"AdditionalShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"AdditionalShippingAttribute","type":"object","description":"AdditionalShippingAttribute"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"RegionInformation":{"properties":{"countryCode":{"description":"ISO 3166 ALPHA-2 of country","maxLength":2,"minLength":2,"type":"string"},"postalCodes":{"description":"List of postal codes for this region","items":{"type":"string"},"maxItems":100,"type":"array"}},"required":["countryCode"],"title":"RegionInformation","type":"object","description":"RegionInformation"},"MandatoryShippingArticleAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping article attribute"},"category":{"description":"The category of this shipping article attribute","enum":["customs","dimensions","insurance"],"type":"string"},"dataType":{"description":"The data type of this shipping article attribute","enum":["NUMBER","STRING"],"type":"string"},"description":{"description":"Description of this shipping article attribute","type":"string"},"referencedField":{"description":"The referenced field for this shipping article attribute","enum":["attributes.weightPerUnit","attributes.hsCode","attributes.currency","attributes.valuePerUnit","attributes.countryOfManufacture"],"type":"string"}},"required":["referencedField","dataType","category","descriptionLocalized"],"title":"MandatoryShippingArticleAttribute","type":"object","description":"MandatoryShippingArticleAttribute"},"MandatoryShippingAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this shipping attribute"},"dataType":{"description":"The data type of this shipping attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this shipping attribute","type":"string"},"referencedField":{"description":"- dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items\n- productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items","enum":["dimensions.weight","productValue","pickUpInformation.startTime","pickUpInformation.endTime","services.BulkyGoods","services.Signature","services.AdultSignature","services.CustomerSignature","services.SaturdayDelivery","services.IdentityCheckPrivate","services.IdentityCheckCompany","services.AdditionalTransportInsurance","carrierInformation.shippingContainerNumber","services.NoNeighborDelivery","services.HandoverToRecipientOnly","services.IdentityAgeCheck18"],"type":"string"}},"title":"MandatoryShippingAttribute","type":"object","description":"MandatoryShippingAttribute"},"MandatoryShippingItemAttribute":{"properties":{"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Localized description of this attribute"},"dataType":{"description":"The data type of this attribute","enum":["Number","String","Date","Boolean"],"type":"string"},"description":{"description":"Description of this attribute","type":"string"},"referencedField":{"deprecated":true,"description":"Deprecated: description: article.title will be used instead, weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit","enum":["description","weightInGram","quantity","parcelItemValue.value","parcelItemValue.currency","countryOfManufacture","tenantArticleId"],"type":"string"}},"title":"MandatoryShippingItemAttribute","type":"object","description":"MandatoryShippingItemAttribute"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"CarrierPickUpTime":{"properties":{"end":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"End time of the pick up window"},"start":{"allOf":[{"$ref":"#/components/schemas/TimeStamp"}],"description":"Start time of the pick up window"}},"required":["start","end"],"title":"CarrierPickUpTime","type":"object","description":"CarrierPickUpTime"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"NonDeliveryDaysPerCountryAndProvince":{"properties":{"country":{"description":"The country code","type":"string"},"nonDeliveryDays":{"description":"Non-delivery days for this country","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"nonDeliveryDaysPerProvince":{"description":"Non-delivery days per province within this country","items":{"$ref":"#/components/schemas/NonDeliveryDaysPerProvince"},"maxItems":500,"type":"array"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this country","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["country","nonDeliveryDays","recurringNonDeliveryWeekdays","nonDeliveryDaysPerProvince"],"title":"NonDeliveryDaysPerCountryAndProvince","type":"object","description":"NonDeliveryDaysPerCountryAndProvince"},"NonDeliveryDays":{"properties":{"nonDeliveryDay":{"description":"The non-delivery day in YYYY-MM-DD format","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"nonDeliveryType":{"default":"SINGLE","description":"Type of non-delivery day","enum":["SINGLE","RECURRING"],"type":"string"}},"required":["nonDeliveryDay"],"title":"NonDeliveryDays","type":"object","description":"NonDeliveryDays"},"NonDeliveryDaysPerProvince":{"properties":{"nonDeliveryDays":{"description":"Non-delivery days for this province","items":{"$ref":"#/components/schemas/NonDeliveryDays"},"maxItems":500,"type":"array"},"province":{"description":"The province identifier","type":"string"},"recurringNonDeliveryWeekdays":{"description":"Recurring non-delivery weekdays for this province","items":{"enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"maxItems":7,"type":"array"}},"required":["province","nonDeliveryDays","recurringNonDeliveryWeekdays"],"title":"NonDeliveryDaysPerProvince","type":"object","description":"NonDeliveryDaysPerProvince"},"ThresholdPriceValue":{"properties":{"priceRange":{"allOf":[{"$ref":"#/components/schemas/PriceRange"}],"description":"Price range for which this threshold applies"},"priority":{"description":"The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority is used when comparing multiple carriers.","minimum":1,"type":"number"}},"required":["priority","priceRange"],"title":"ThresholdPriceValue","type":"object","description":"ThresholdPriceValue"},"PriceRange":{"properties":{"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","format":"int32","minimum":0,"type":"integer"},"from":{"description":"Lowest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"number"},"to":{"description":"Highest total parcel value that this carrier will be selected for. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"number"}},"required":["from","to","currency","decimalPlaces"],"title":"PriceRange","type":"object","description":"PriceRange"}}}}
```

## The VersionedResource object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"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"}}}}
```

## The VersionlessUpdateStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"VersionlessUpdateStock":{"properties":{"name":{"enum":["UPDATE_VERSIONLESS"],"type":"string"},"stocks":{"description":"Please be sure to include each stock (by ID) only once, when updating. Otherwise the whole batch is rejected with an error.","items":{"discriminator":{"propertyName":"operationType"},"oneOf":[{"$ref":"#/components/schemas/StockForCreationVersionless"},{"$ref":"#/components/schemas/StockForUpdateVersionless"}]},"maxItems":25,"type":"array"}},"required":["name","stocks"],"title":"VersionlessUpdateStock","type":"object","description":"VersionlessUpdateStock"},"StockForCreationVersionless":{"properties":{"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"facilityRef":{"deprecated":true,"description":"facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"operationType":{"enum":["CREATE"],"type":"string"},"properties":{"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"},{"additionalProperties":{"type":"string"},"type":"object"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantFacilityId":{"deprecated":true,"description":"tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["tenantArticleId","value","operationType"],"title":"StockForCreationVersionless","type":"object","description":"StockForCreationVersionless"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"StockForUpdateVersionless":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"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"},"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"operationType":{"enum":["UPDATE"],"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["value","id","operationType"],"title":"StockForUpdateVersionless","type":"object","description":"StockForUpdateVersionless"}}}}
```

## The WaitForInputItemReturnActionParameter object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WaitForInputItemReturnActionParameter":{"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"enum":["WaitForInputItemReturn"],"type":"string"}},"required":["name","itemReturnJobVersion"],"title":"WaitForInputItemReturnActionParameter","type":"object","description":"WaitForInputItemReturnActionParameter"}}}}
```

## The WebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"}}}}
```

## The WeekDay object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WeekDay":{"description":"A weekday","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string","xml":{"name":"WeekDay"},"title":"WeekDay"}}}}
```

## The WorkflowCondition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowCondition":{"properties":{"entity":{"description":"Entity type that the condition applies to","enum":["ORDER","INCOMING_EVENT","FACILITY"],"type":"string"},"expression":{"description":"Expression that defines the condition","type":"string"}},"required":["expression","entity"],"title":"WorkflowCondition","type":"object","description":"WorkflowCondition"}}}}
```

## The WorkflowConnection object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowConnection":{"properties":{"from":{"description":"Source node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.TRUE\")","type":"string"},"to":{"description":"Target node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.FALSE\")","type":"string"}},"required":["from","to"],"title":"WorkflowConnection","type":"object","description":"WorkflowConnection"}}}}
```

## The WorkflowDefinition object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowDefinition":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleStringRequired"}],"description":"Localized human-readable name of the workflow. At least one locale value is required."},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of what the workflow does"},"connections":{"description":"Array of connections between workflow nodes","items":{"$ref":"#/components/schemas/WorkflowConnection"},"maxItems":10,"type":"array"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"id":{"description":"Unique identifier for the workflow definition","type":"string"},"isActive":{"description":"Whether the workflow definition is active","type":"boolean"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"nodes":{"description":"Array of workflow nodes","items":{"oneOf":[{"$ref":"#/components/schemas/FFTActivityNode"},{"$ref":"#/components/schemas/GuardWorkflowNode"},{"$ref":"#/components/schemas/ConditionWorkflowNode"}]},"maxItems":100,"type":"array"},"rootId":{"description":"Key of the root node where workflow execution begins","type":"string"},"tenantWorkflowId":{"description":"Unique tenant id for the workflow definition. Must not contain \".\" or \"$\" characters.","type":"string"},"type":{"description":"Type of workflow. Currently only ORDER workflows are supported","enum":["ORDER"],"type":"string"},"version":{"description":"Current version of the workflow definition for optimistic locking","type":"number"}},"required":["tenantWorkflowId","type","nameLocalized","rootId","nodes","connections","id","version","isActive"],"title":"WorkflowDefinition","type":"object","description":"WorkflowDefinition"},"WorkflowNameLocaleStringRequired":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","minProperties":1,"title":"WorkflowNameLocaleStringRequired","type":"object"},"WorkflowDescriptionLocaleString":{"additionalProperties":{"maxLength":500,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowDescriptionLocaleString","type":"object"},"WorkflowConnection":{"properties":{"from":{"description":"Source node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.TRUE\")","type":"string"},"to":{"description":"Target node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.FALSE\")","type":"string"}},"required":["from","to"],"title":"WorkflowConnection","type":"object","description":"WorkflowConnection"},"FFTActivityNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node - module nodes that map to business entities","enum":["ORDER_MODULE","PICKING_MODULE","PACKING_MODULE","HANDOVER_MODULE","RESERVATION_MODULE","ROUTING_MODULE","SHIPPING_MODULE","SERVICES_MODULE"],"type":"string"}},"required":["key","type"],"title":"FFTActivityNode","type":"object","description":"FFTActivityNode"},"WorkflowNameLocaleString":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowNameLocaleString","type":"object"},"GuardWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"description":"Guard condition: an expression or a built-in (preconfigured) guard.","discriminator":{"mapping":{"EXPRESSION":"#/components/schemas/ExpressionGuardCondition","PRECONFIGURED":"#/components/schemas/PreconfiguredGuardCondition"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/ExpressionGuardCondition"},{"$ref":"#/components/schemas/PreconfiguredGuardCondition"}]},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["GUARD"],"type":"string"}},"required":["key","type","condition"],"title":"GuardWorkflowNode","type":"object","description":"GuardWorkflowNode"},"ExpressionGuardCondition":{"properties":{"entity":{"description":"Entity the expression applies to","enum":["ORDER","INCOMING_EVENT"],"type":"string"},"expression":{"description":"JSONPath expression evaluated to decide the guard.","type":"string"},"kind":{"description":"Discriminator: expression-based guard.","enum":["EXPRESSION"],"type":"string"}},"required":["kind","expression","entity"],"title":"ExpressionGuardCondition","type":"object","description":"ExpressionGuardCondition"},"PreconfiguredGuardCondition":{"properties":{"kind":{"description":"Discriminator: built-in guard.","enum":["PRECONFIGURED"],"type":"string"},"preconfigured":{"description":"Which built-in guard to run","enum":["ORDER_GATE"],"type":"string"}},"required":["kind","preconfigured"],"title":"PreconfiguredGuardCondition","type":"object","description":"PreconfiguredGuardCondition"},"ConditionWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"allOf":[{"$ref":"#/components/schemas/WorkflowCondition"}],"description":"Condition expression that determines the path. Connections from this node must use .TRUE or .FALSE suffixes"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["CONDITION"],"type":"string"}},"required":["key","type","condition"],"title":"ConditionWorkflowNode","type":"object","description":"ConditionWorkflowNode"},"WorkflowCondition":{"properties":{"entity":{"description":"Entity type that the condition applies to","enum":["ORDER","INCOMING_EVENT","FACILITY"],"type":"string"},"expression":{"description":"Expression that defines the condition","type":"string"}},"required":["expression","entity"],"title":"WorkflowCondition","type":"object","description":"WorkflowCondition"}}}}
```

## The WorkflowDefinitionAction object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowDefinitionAction":{"properties":{"name":{"description":"Which action to perform on the workflow definition","enum":["ACTIVATE"],"type":"string"}},"required":["name"],"title":"WorkflowDefinitionAction","type":"object","description":"WorkflowDefinitionAction"}}}}
```

## The WorkflowDefinitionForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowDefinitionForCreation":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleStringRequired"}],"description":"Localized human-readable name of the workflow. At least one locale value is required."},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of what the workflow does"},"connections":{"description":"Array of connections between workflow nodes","items":{"$ref":"#/components/schemas/WorkflowConnection"},"maxItems":10,"type":"array"},"nodes":{"description":"Array of workflow nodes","items":{"oneOf":[{"$ref":"#/components/schemas/FFTActivityNode"},{"$ref":"#/components/schemas/GuardWorkflowNode"},{"$ref":"#/components/schemas/ConditionWorkflowNode"}]},"maxItems":100,"type":"array"},"rootId":{"description":"Key of the root node where workflow execution begins","type":"string"},"tenantWorkflowId":{"description":"Unique tenant id for the workflow definition. Must not contain \".\" or \"$\" characters.","type":"string"},"type":{"description":"Type of workflow. Currently only ORDER workflows are supported","enum":["ORDER"],"type":"string"}},"required":["tenantWorkflowId","type","nameLocalized","rootId","nodes","connections"],"title":"WorkflowDefinitionForCreation","type":"object","description":"WorkflowDefinitionForCreation"},"WorkflowNameLocaleStringRequired":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","minProperties":1,"title":"WorkflowNameLocaleStringRequired","type":"object"},"WorkflowDescriptionLocaleString":{"additionalProperties":{"maxLength":500,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowDescriptionLocaleString","type":"object"},"WorkflowConnection":{"properties":{"from":{"description":"Source node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.TRUE\")","type":"string"},"to":{"description":"Target node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.FALSE\")","type":"string"}},"required":["from","to"],"title":"WorkflowConnection","type":"object","description":"WorkflowConnection"},"FFTActivityNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node - module nodes that map to business entities","enum":["ORDER_MODULE","PICKING_MODULE","PACKING_MODULE","HANDOVER_MODULE","RESERVATION_MODULE","ROUTING_MODULE","SHIPPING_MODULE","SERVICES_MODULE"],"type":"string"}},"required":["key","type"],"title":"FFTActivityNode","type":"object","description":"FFTActivityNode"},"WorkflowNameLocaleString":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowNameLocaleString","type":"object"},"GuardWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"description":"Guard condition: an expression or a built-in (preconfigured) guard.","discriminator":{"mapping":{"EXPRESSION":"#/components/schemas/ExpressionGuardCondition","PRECONFIGURED":"#/components/schemas/PreconfiguredGuardCondition"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/ExpressionGuardCondition"},{"$ref":"#/components/schemas/PreconfiguredGuardCondition"}]},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["GUARD"],"type":"string"}},"required":["key","type","condition"],"title":"GuardWorkflowNode","type":"object","description":"GuardWorkflowNode"},"ExpressionGuardCondition":{"properties":{"entity":{"description":"Entity the expression applies to","enum":["ORDER","INCOMING_EVENT"],"type":"string"},"expression":{"description":"JSONPath expression evaluated to decide the guard.","type":"string"},"kind":{"description":"Discriminator: expression-based guard.","enum":["EXPRESSION"],"type":"string"}},"required":["kind","expression","entity"],"title":"ExpressionGuardCondition","type":"object","description":"ExpressionGuardCondition"},"PreconfiguredGuardCondition":{"properties":{"kind":{"description":"Discriminator: built-in guard.","enum":["PRECONFIGURED"],"type":"string"},"preconfigured":{"description":"Which built-in guard to run","enum":["ORDER_GATE"],"type":"string"}},"required":["kind","preconfigured"],"title":"PreconfiguredGuardCondition","type":"object","description":"PreconfiguredGuardCondition"},"ConditionWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"allOf":[{"$ref":"#/components/schemas/WorkflowCondition"}],"description":"Condition expression that determines the path. Connections from this node must use .TRUE or .FALSE suffixes"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["CONDITION"],"type":"string"}},"required":["key","type","condition"],"title":"ConditionWorkflowNode","type":"object","description":"ConditionWorkflowNode"},"WorkflowCondition":{"properties":{"entity":{"description":"Entity type that the condition applies to","enum":["ORDER","INCOMING_EVENT","FACILITY"],"type":"string"},"expression":{"description":"Expression that defines the condition","type":"string"}},"required":["expression","entity"],"title":"WorkflowCondition","type":"object","description":"WorkflowCondition"}}}}
```

## The WorkflowDefinitionForUpdate object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowDefinitionForUpdate":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleStringRequired"}],"description":"Localized human-readable name of the workflow. At least one locale value is required."},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of what the workflow does"},"connections":{"description":"Array of connections between workflow nodes","items":{"$ref":"#/components/schemas/WorkflowConnection"},"maxItems":10,"type":"array"},"id":{"description":"Unique identifier for the workflow definition","type":"string"},"nodes":{"description":"Array of workflow nodes","items":{"oneOf":[{"$ref":"#/components/schemas/FFTActivityNode"},{"$ref":"#/components/schemas/GuardWorkflowNode"},{"$ref":"#/components/schemas/ConditionWorkflowNode"}]},"maxItems":100,"type":"array"},"rootId":{"description":"Key of the root node where workflow execution begins","type":"string"},"tenantWorkflowId":{"description":"Unique tenant id for the workflow definition. Must not contain \".\" or \"$\" characters.","type":"string"},"type":{"description":"Type of workflow. Currently only ORDER workflows are supported","enum":["ORDER"],"type":"string"},"version":{"description":"Current version of the workflow definition for optimistic locking","type":"number"}},"required":["tenantWorkflowId","type","nameLocalized","rootId","nodes","connections","id","version"],"title":"WorkflowDefinitionForUpdate","type":"object","description":"WorkflowDefinitionForUpdate"},"WorkflowNameLocaleStringRequired":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","minProperties":1,"title":"WorkflowNameLocaleStringRequired","type":"object"},"WorkflowDescriptionLocaleString":{"additionalProperties":{"maxLength":500,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowDescriptionLocaleString","type":"object"},"WorkflowConnection":{"properties":{"from":{"description":"Source node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.TRUE\")","type":"string"},"to":{"description":"Target node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.FALSE\")","type":"string"}},"required":["from","to"],"title":"WorkflowConnection","type":"object","description":"WorkflowConnection"},"FFTActivityNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node - module nodes that map to business entities","enum":["ORDER_MODULE","PICKING_MODULE","PACKING_MODULE","HANDOVER_MODULE","RESERVATION_MODULE","ROUTING_MODULE","SHIPPING_MODULE","SERVICES_MODULE"],"type":"string"}},"required":["key","type"],"title":"FFTActivityNode","type":"object","description":"FFTActivityNode"},"WorkflowNameLocaleString":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowNameLocaleString","type":"object"},"GuardWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"description":"Guard condition: an expression or a built-in (preconfigured) guard.","discriminator":{"mapping":{"EXPRESSION":"#/components/schemas/ExpressionGuardCondition","PRECONFIGURED":"#/components/schemas/PreconfiguredGuardCondition"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/ExpressionGuardCondition"},{"$ref":"#/components/schemas/PreconfiguredGuardCondition"}]},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["GUARD"],"type":"string"}},"required":["key","type","condition"],"title":"GuardWorkflowNode","type":"object","description":"GuardWorkflowNode"},"ExpressionGuardCondition":{"properties":{"entity":{"description":"Entity the expression applies to","enum":["ORDER","INCOMING_EVENT"],"type":"string"},"expression":{"description":"JSONPath expression evaluated to decide the guard.","type":"string"},"kind":{"description":"Discriminator: expression-based guard.","enum":["EXPRESSION"],"type":"string"}},"required":["kind","expression","entity"],"title":"ExpressionGuardCondition","type":"object","description":"ExpressionGuardCondition"},"PreconfiguredGuardCondition":{"properties":{"kind":{"description":"Discriminator: built-in guard.","enum":["PRECONFIGURED"],"type":"string"},"preconfigured":{"description":"Which built-in guard to run","enum":["ORDER_GATE"],"type":"string"}},"required":["kind","preconfigured"],"title":"PreconfiguredGuardCondition","type":"object","description":"PreconfiguredGuardCondition"},"ConditionWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"allOf":[{"$ref":"#/components/schemas/WorkflowCondition"}],"description":"Condition expression that determines the path. Connections from this node must use .TRUE or .FALSE suffixes"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["CONDITION"],"type":"string"}},"required":["key","type","condition"],"title":"ConditionWorkflowNode","type":"object","description":"ConditionWorkflowNode"},"WorkflowCondition":{"properties":{"entity":{"description":"Entity type that the condition applies to","enum":["ORDER","INCOMING_EVENT","FACILITY"],"type":"string"},"expression":{"description":"Expression that defines the condition","type":"string"}},"required":["expression","entity"],"title":"WorkflowCondition","type":"object","description":"WorkflowCondition"}}}}
```

## The WorkflowDescriptionLocaleString object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowDescriptionLocaleString":{"additionalProperties":{"maxLength":500,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowDescriptionLocaleString","type":"object"}}}}
```

## The WorkflowInformation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"}}}}
```

## The WorkflowNameLocaleString object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowNameLocaleString":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowNameLocaleString","type":"object"}}}}
```

## The WorkflowNameLocaleStringRequired object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowNameLocaleStringRequired":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","minProperties":1,"title":"WorkflowNameLocaleStringRequired","type":"object"}}}}
```

## The WorkflowPaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowPaginatedResult":{"properties":{"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"},"workflows":{"items":{"$ref":"#/components/schemas/WorkflowDefinition"},"type":"array"}},"required":["pageInfo","workflows"],"title":"WorkflowPaginatedResult","type":"object","description":"WorkflowPaginatedResult"},"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"},"WorkflowDefinition":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleStringRequired"}],"description":"Localized human-readable name of the workflow. At least one locale value is required."},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of what the workflow does"},"connections":{"description":"Array of connections between workflow nodes","items":{"$ref":"#/components/schemas/WorkflowConnection"},"maxItems":10,"type":"array"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"id":{"description":"Unique identifier for the workflow definition","type":"string"},"isActive":{"description":"Whether the workflow definition is active","type":"boolean"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"nodes":{"description":"Array of workflow nodes","items":{"oneOf":[{"$ref":"#/components/schemas/FFTActivityNode"},{"$ref":"#/components/schemas/GuardWorkflowNode"},{"$ref":"#/components/schemas/ConditionWorkflowNode"}]},"maxItems":100,"type":"array"},"rootId":{"description":"Key of the root node where workflow execution begins","type":"string"},"tenantWorkflowId":{"description":"Unique tenant id for the workflow definition. Must not contain \".\" or \"$\" characters.","type":"string"},"type":{"description":"Type of workflow. Currently only ORDER workflows are supported","enum":["ORDER"],"type":"string"},"version":{"description":"Current version of the workflow definition for optimistic locking","type":"number"}},"required":["tenantWorkflowId","type","nameLocalized","rootId","nodes","connections","id","version","isActive"],"title":"WorkflowDefinition","type":"object","description":"WorkflowDefinition"},"WorkflowNameLocaleStringRequired":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","minProperties":1,"title":"WorkflowNameLocaleStringRequired","type":"object"},"WorkflowDescriptionLocaleString":{"additionalProperties":{"maxLength":500,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowDescriptionLocaleString","type":"object"},"WorkflowConnection":{"properties":{"from":{"description":"Source node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.TRUE\")","type":"string"},"to":{"description":"Target node key. For condition nodes, may include .TRUE or .FALSE suffix (e.g., \"fraud-check.FALSE\")","type":"string"}},"required":["from","to"],"title":"WorkflowConnection","type":"object","description":"WorkflowConnection"},"FFTActivityNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node - module nodes that map to business entities","enum":["ORDER_MODULE","PICKING_MODULE","PACKING_MODULE","HANDOVER_MODULE","RESERVATION_MODULE","ROUTING_MODULE","SHIPPING_MODULE","SERVICES_MODULE"],"type":"string"}},"required":["key","type"],"title":"FFTActivityNode","type":"object","description":"FFTActivityNode"},"WorkflowNameLocaleString":{"additionalProperties":{"maxLength":100,"minLength":2,"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"WorkflowNameLocaleString","type":"object"},"GuardWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"description":"Guard condition: an expression or a built-in (preconfigured) guard.","discriminator":{"mapping":{"EXPRESSION":"#/components/schemas/ExpressionGuardCondition","PRECONFIGURED":"#/components/schemas/PreconfiguredGuardCondition"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/ExpressionGuardCondition"},{"$ref":"#/components/schemas/PreconfiguredGuardCondition"}]},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["GUARD"],"type":"string"}},"required":["key","type","condition"],"title":"GuardWorkflowNode","type":"object","description":"GuardWorkflowNode"},"ExpressionGuardCondition":{"properties":{"entity":{"description":"Entity the expression applies to","enum":["ORDER","INCOMING_EVENT"],"type":"string"},"expression":{"description":"JSONPath expression evaluated to decide the guard.","type":"string"},"kind":{"description":"Discriminator: expression-based guard.","enum":["EXPRESSION"],"type":"string"}},"required":["kind","expression","entity"],"title":"ExpressionGuardCondition","type":"object","description":"ExpressionGuardCondition"},"PreconfiguredGuardCondition":{"properties":{"kind":{"description":"Discriminator: built-in guard.","enum":["PRECONFIGURED"],"type":"string"},"preconfigured":{"description":"Which built-in guard to run","enum":["ORDER_GATE"],"type":"string"}},"required":["kind","preconfigured"],"title":"PreconfiguredGuardCondition","type":"object","description":"PreconfiguredGuardCondition"},"ConditionWorkflowNode":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowNameLocaleString"}],"description":"Localized name of the node"},"descriptionLocalized":{"allOf":[{"$ref":"#/components/schemas/WorkflowDescriptionLocaleString"}],"description":"Localized description of the node"},"condition":{"allOf":[{"$ref":"#/components/schemas/WorkflowCondition"}],"description":"Condition expression that determines the path. Connections from this node must use .TRUE or .FALSE suffixes"},"description":{"description":"Description resolved to the requesting user's locale (read-only)","type":"string"},"key":{"description":"Unique identifier for this node within the workflow","type":"string"},"name":{"description":"Name resolved to the requesting user's locale (read-only)","type":"string"},"type":{"description":"Type of the workflow node","enum":["CONDITION"],"type":"string"}},"required":["key","type","condition"],"title":"ConditionWorkflowNode","type":"object","description":"ConditionWorkflowNode"},"WorkflowCondition":{"properties":{"entity":{"description":"Entity type that the condition applies to","enum":["ORDER","INCOMING_EVENT","FACILITY"],"type":"string"},"expression":{"description":"Expression that defines the condition","type":"string"}},"required":["expression","entity"],"title":"WorkflowCondition","type":"object","description":"WorkflowCondition"}}}}
```

## The WorkflowSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowSearchPayload":{"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/WorkflowSearchQuery"},"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/WorkflowSort"},"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":"WorkflowSearchPayload","type":"object","description":"WorkflowSearchPayload"},"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"},"WorkflowSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/WorkflowSearchQuery"},"maxItems":500,"type":"array"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"isActive":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by isActive"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/WorkflowSearchQuery"},"maxItems":500,"type":"array"},"tenantWorkflowId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantWorkflowId"}},"title":"WorkflowSearchQuery","type":"object","description":"WorkflowSearchQuery"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"LocalizedStringSearchFilter":{"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":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"},"WorkflowSort":{"properties":{"id":{"enum":["ASC","DESC"],"type":"string"}},"title":"WorkflowSort","type":"object","description":"WorkflowSort"}}}}
```

## The WorkflowSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/WorkflowSearchQuery"},"maxItems":500,"type":"array"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"isActive":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by isActive"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/WorkflowSearchQuery"},"maxItems":500,"type":"array"},"tenantWorkflowId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantWorkflowId"}},"title":"WorkflowSearchQuery","type":"object","description":"WorkflowSearchQuery"},"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"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"LocalizedStringSearchFilter":{"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":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"}}}}
```

## The WorkflowSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowSort":{"properties":{"id":{"enum":["ASC","DESC"],"type":"string"}},"title":"WorkflowSort","type":"object","description":"WorkflowSort"}}}}
```

## The WorkflowUnavailable object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## The Zone object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Zone":{"allOf":[{"$ref":"#/components/schemas/ZoneForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"}},"required":["id","facilityRef"],"type":"object","xml":{"name":"Zone"},"title":"Zone","description":"Zone"},"ZoneForReplacement":{"allOf":[{"$ref":"#/components/schemas/ZoneForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ZoneForReplacement"},"title":"ZoneForReplacement","description":"ZoneForReplacement"},"ZoneForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"}},"required":["name","score"],"type":"object","xml":{"name":"ZoneForCreation"},"title":"ZoneForCreation","description":"ZoneForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"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"}}}}
```

## The ZoneForCreation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ZoneForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"}},"required":["name","score"],"type":"object","xml":{"name":"ZoneForCreation"},"title":"ZoneForCreation","description":"ZoneForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"}}}}
```

## The ZoneForReplacement object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ZoneForReplacement":{"allOf":[{"$ref":"#/components/schemas/ZoneForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ZoneForReplacement"},"title":"ZoneForReplacement","description":"ZoneForReplacement"},"ZoneForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"}},"required":["name","score"],"type":"object","xml":{"name":"ZoneForCreation"},"title":"ZoneForCreation","description":"ZoneForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"}}}}
```

## The ZonePaginatedResult object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ZonePaginatedResult":{"properties":{"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"},"zones":{"items":{"$ref":"#/components/schemas/Zone"},"type":"array"}},"required":["pageInfo","zones"],"title":"ZonePaginatedResult","type":"object","description":"ZonePaginatedResult"},"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"},"Zone":{"allOf":[{"$ref":"#/components/schemas/ZoneForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"}},"required":["id","facilityRef"],"type":"object","xml":{"name":"Zone"},"title":"Zone","description":"Zone"},"ZoneForReplacement":{"allOf":[{"$ref":"#/components/schemas/ZoneForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"ZoneForReplacement"},"title":"ZoneForReplacement","description":"ZoneForReplacement"},"ZoneForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"}},"required":["name","score"],"type":"object","xml":{"name":"ZoneForCreation"},"title":"ZoneForCreation","description":"ZoneForCreation"},"CustomAttributesResource":{"properties":{"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"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"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"}}}}
```

## The ZoneSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ZoneSearchPayload":{"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/ZoneSearchQuery"},"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/ZoneSort"},"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":"ZoneSearchPayload","type":"object","description":"ZoneSearchPayload"},"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"},"ZoneSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ZoneSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/ZoneSearchQuery"},"maxItems":500,"type":"array"}},"title":"ZoneSearchQuery","type":"object","description":"ZoneSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"},"ZoneSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ZoneSort","type":"object","description":"ZoneSort"}}}}
```

## The ZoneSearchQuery object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ZoneSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/ZoneSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"items":{"$ref":"#/components/schemas/ZoneSearchQuery"},"maxItems":500,"type":"array"}},"title":"ZoneSearchQuery","type":"object","description":"ZoneSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"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"},"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"}}}}
```

## The ZoneSort object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ZoneSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ZoneSort","type":"object","description":"ZoneSort"}}}}
```

## The ZoneWebHookEventPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ZoneWebHookEventPayload":{"properties":{"created":{"description":"The date when the zone was created","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"The reference to the facility associated with the zone","type":"string"},"id":{"description":"The unique identifier of the zone","type":"string"},"lastModified":{"description":"The date when the zone was last modified","format":"date-time","type":"string"},"name":{"description":"The name of the zone","type":"string"},"score":{"description":"The score of the zone","type":"number"},"version":{"description":"The version of the zone","type":"number"}},"required":["version","id","facilityRef","name","score"],"title":"ZoneWebHookEventPayload","type":"object","description":"ZoneWebHookEventPayload"}}}}
```

## The ZoneWebHookEventPayloadWebHookEvent object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ZoneWebHookEventPayloadWebHookEvent":{"allOf":[{"$ref":"#/components/schemas/WebHookEvent"}],"properties":{"payload":{"$ref":"#/components/schemas/ZoneWebHookEventPayload"}},"required":["payload"],"title":"ZoneWebHookEventPayloadWebHookEvent","type":"object","description":"ZoneWebHookEventPayloadWebHookEvent"},"WebHookEvent":{"properties":{"event":{"description":"The type of the send event","type":"string"},"eventId":{"description":"The id of the event","type":"string"}},"required":["event","eventId"],"type":"object","title":"WebHookEvent","description":"WebHookEvent"},"ZoneWebHookEventPayload":{"properties":{"created":{"description":"The date when the zone was created","format":"date-time","type":"string"},"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"},"facilityRef":{"description":"The reference to the facility associated with the zone","type":"string"},"id":{"description":"The unique identifier of the zone","type":"string"},"lastModified":{"description":"The date when the zone was last modified","format":"date-time","type":"string"},"name":{"description":"The name of the zone","type":"string"},"score":{"description":"The score of the zone","type":"number"},"version":{"description":"The version of the zone","type":"number"}},"required":["version","id","facilityRef","name","score"],"title":"ZoneWebHookEventPayload","type":"object","description":"ZoneWebHookEventPayload"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.fulfillmenttools.com/documentation/apis/api-reference/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.